The Complex World

From Developer to Designer

Làm thế nào để viết một tutorial chất lượng?

Mình đang đọc tutorial về Construct 2, bỗng thấy một bài viết với tựa đề How to write a good tutorial. Nhớ lại, lâu lâu, có một vài tutorial viết kiểu như là introduction hơn là tutorial. Bản thân cũng chưa viết nhiều tutorial, nhưng cũng bon chen tào lao về vụ này.

Teach and Learn

Bạn đã có ý tưởng gì chưa?

Nếu đã có ý tưởng thì bạn nên xác định lại là nên viết về cái gì. Chẳng hạn, bạn muốn viết về "Hướng dẫn làm game với HTML5". Nếu cảm thấy quá rộng thì hãy chia nhỏ ra từng vấn đề rồi hãy viết. Như là viết về semantic tag, thẻ <video> thay thế Flash như thế nào,... Hồi xưa, mình cũng có viết vài tutorial cho tụi bạn trong nhóm đọc. Kết quả sau khi viết xong, sao mà kéo hoài chưa hết vậy? Với lại nhiều quá, coi xong cũng chả nhớ gì cả.

Ngoài ra, bạn cũng đừng có ngần ngại việc trùng nội dung với các tutorial đã có sẵn. Chẳng hạn, có người đã viết về Web Storage trong HTML5. Nhưng họ dùng từ ngữ chuyên môn, đọc chả hiểu gì hết. Bạn có thể viết lại vấn đề Web Storage theo cách hiểu của bạn. Không chừng, cách dùng từ của bạn nhiều người hiểu hơn bài viết có sẵn thì sao. Bởi vậy, mới có loại sách "For dummies". Cá nhân mình thấy cách dùng từ của loại sách này dễ hiểu hơn so với sách của O'Reilly Media.

Idea

Sắp xếp ý tưởng của bạn

Sau khi đã xác định xong vấn đề. Bạn hãy sắp xếp ý tưởng và có thể dựa theo những câu hỏi dưới đây:

  • Bạn muốn hướng dẫn mọi người cái gì?
  • Những ý chính bạn muốn viết là gì?
  • Nên sắp xếp thứ tự các ý như thế nào?
  • Nên mô tả vấn đề như thế nào sao cho cực kỳ đơn giản và dễ hiểu?

Thường thì mình không dựa theo những câu hỏi trên. Mình dựa theo Five Ws để viết. Dù theo hướng nào đi nữa thì cũng nên tập trung vấn đề, viết rõ ràng và kiến thức phải chính xác.

Five Ws

Viết tutorial

How to write a tutorial?

Tiêu đề

Bạn chọn một tiêu đề sao cho ngắn gọn và thể hiện được toàn bộ nội dung của bài viết. Nó cũng góp phần giúp bạn không đi lạc đề.

Nội dung

Nội dung được thể hiện theo cách của từng người. Bạn có thể in đậm, in nghiêng, chèn icon, hình ảnh,... các thể loại. Nên chia nội dung theo từng đoạn để người đọc dễ dàng hình dung vấn đề.

Mô tả nội dung

Phần này có thể có hoặc không. Nhưng vẫn nên có để mọi người hiểu rõ hơn nội dung của bài viết. Đoạn này viết ngắn gọn thôi, ai thích thì sẽ tự vào đọc chi tiết.

Tag

Phần này giúp bạn phân loại bài viết dễ dàng. Bạn nên sử dụng tối đa là 5 tag, xài nhiều quá không có hiệu quả cho lắm. Nếu bạn là thành viên của Dạy Nhau Học chắc sẽ quen với khái niệm này.

Kiểm tra lỗi chính tả

Vấn đề này có lẽ ít ai quan tâm. Nhưng đôi lúc, việc bạn viết sai chính tả sẽ ảnh hưởng tới sự tiếp thu của người đọc. Nếu bạn viết sai thuật ngữ tiếng Anh thì càng tai hại nữa. May mắn cho các bạn là dạo này Google nó cũng "bớt ngu", tự động suggest cho bạn từ liên quan.

Đừng lo lắng!

Dù bạn đã có hay chưa có kinh nghiệm trong việc viết tutorial thì cũng nên mạnh dạn viết. Viết tutorial giúp bạn chia sẻ kiến thức tới mọi người. Trong quá trình viết, bạn sẽ phải nghiên cứu nhiều thứ để đảm bảo thông tin bạn chia sẻ là chính xác. Hồi còn học phổ thông, thầy mình đã nói khi giúp đỡ người khác một lần thì cũng coi như tự mình ôn lại kiến thức một lần.

Ngoài ra, viết tutorial cũng giúp bạn cải thiện khả năng giao tiếp nữa. Nhưng không hiểu sao, bản thân mình thì cải thiện khả năng diễn đạt bằng văn bản, chứ khi nói chuyện trực tiếp vẫn còn gặp khó khăn.

Don't worry, be happy

Tham khảo