Viết lời hướng dẫn

Từ VLOS
Bước tới: chuyển hướng, tìm kiếm

Viết lời hướng dẫn là nhiệm vụ khá khó khăn, nhưng thực ra lại dễ dàng hơn bạn nghĩ! Những bước sau có thể áp dụng cho bất cứ lời hướng dẫn nào, từ những hướng dẫn đơn giản (Cách Vỗ tay) cho đến những chủ đề phức tạp hơn (Các Chế tạo Bán dẫn).

Các bước[sửa]

Tìm hiểu Chủ đề[sửa]

  1. Đây chính là điểm mấu chốt. Có thể điều này là hiển nhiên, nhưng kiến thức chính là chìa khóa để bạn viết được lời hướng dẫn thành công. Ví dụ, nếu bạn đang viết về cách sử dụng máy ảnh, bạn cần biết rằng khẩu độ và tốc độ chụp không chỉ là hai chức năng tách biệt—theo đúng bản chất—mà nếu bạn hiểu hai chức năng này tương tác như thế nào với nhau, bạn sẽ có thể dễ dàng miêu tả mỗi chức năng trong mối tương quan với tổng thể.
  2. Nói chuyện với chuyên gia. Nếu vai trò của bạn đơn giản chỉ là người viết chứ không phải chuyên gia về chủ đề bạn đang quan tâm, hãy tìm đến những người có kiến thức trong quá trình bạn viết và đảm bảo lời hướng dẫn của bạn sẽ được họ đọc lại giúp. Kiến thức và lời khuyên của họ là vô giá.
  3. Cố gắng trải nghiệm trực tiếp. Nếu có thể, hãy thử trải nghiệm về điều bạn đang viết, cách này đặc biệt có ích vì bạn có cơ hội được cảm nhận sự vật trong vai trò người dùng để biết họ muốn tìm hiểu về điều gì.
  4. Đọc thêm về chủ đề. Học cách giới thiệu về sản phẩm, và trở thành người tuyên truyền cho sản phẩm bạn đang viết.
    • Những hướng dẫn sử dụng của các sản phẩm tương tự sẽ cho bạn nguồn tham khảo về cách xử lý chủ đề đó của những tác giả khác.
      • Tìm điểm tương đồng giữa các tác giả, đâu là cách họ mô tả chức năng và cách tiếp cận tương đồng.
      • Tìm những điểm khác biệt nổi bật. Những điểm khác biệt này có thể là những chức năng độc đáo của sản phẩm đó. Sản phẩm của bạn có thể có hoặc không có những chức năng này, hoặc bạn có thể tìm những cách khác khi mô tả sản phẩm của mình nhằm tăng giá trị của sản phẩm. Dù công việc của bạn là viết lời hướng dẫn, nhưng cho khách hàng thấy được giá trị của món hàng họ đã mua chính là cách hiệu quả nhất để khuyến khích họ tiếp tục đọc lời hướng dẫn.
    • Tìm hiểu kỹ các tạp chí thương mại. Tìm hiểu xem những người sử dụng sản phẩm này đang tương tác với chúng mỗi ngày như thế nào. Liệu họ có mong muốn sản phẩm có thêm chức năng nào đó để giải quyết một vấn đề cụ thể hay không, và liệu sản phẩm của bạn có phải là một giải pháp không, đó là những điểm nổi bật bạn cần làm .

Lập Dàn ý cho Lời hướng dẫn[sửa]

  1. Chia thành từng phần nhỏ. Dù chỉ là một tờ hướng dẫn từng bước đơn giản, hay một quyển hướng dẫn sử dụng cho chiếc máy ảnh kỹ thuật số 35mm, thì chia thành từng phần nhỏ dễ xử lý sẽ có một số lợi ích sau:
    • Bạn có thể tập trung vào từng phần của tổng thể sản phẩm. Mục tiêu của bạn là giúp người sử dụng làm quen với phương pháp tìm hiểu quá trình sử dụng. Cách sử dụng từng chức năng có thể hướng dẫn trong phần cuối, nếu muốn, hoặc để người sử dụng tự khám phá.
  2. Làm theo trình tự logic. Ví dụ, sẽ không có tác dụng gì nếu bạn mô tả cách hoạt động của đèn flash máy ảnh trước khi mô tả cách lắp ống kính, lắp phim, bật máy ảnh và điều chỉnh lấy nét. Đây cách cực kỳ hiệu quả nếu bạn không thực sự hiểu sâu về chủ đề.
  3. Coi dàn ý đồng thời là mục lục.
  4. Xem lại các bước. Khi bạn đã xác định được các phần logic rồi, hãy xem lại để đảm bảo bạn đã bao quát mọi nội dung.
  5. Thu thập các đồ dùng cần sử dụng. Cần chuẩn bị các đồ dùng bạn đang mô tả và sẵn sàng sử dụng ngay như đã nêu trong lời hướng dẫn. Nếu bạn đang làm một chiếc hộp giấy, bạn sẽ cần chuẩn bị giấy, kéo, băng dính, keo dán, và thước sẵn sàng. Nếu bạn viết về một chiếc máy ảnh, hãy đảm bảo chiếc máy ảnh đã được tháo rời. Nếu có thể, sản phẩm bạn đang viết nên được cho lại vào hộp trong bước này.

Bắt đầu Viết[sửa]

  1. Viết lời giới thiệu. Lời giới thiệu sẽ định hướng giọng văn cho toàn bộ lời hướng dẫn, và cho người đọc tổng quan về loại tài liệu hướng dẫn họ sắp đọc. Liệu đây sẽ là một tài liệu nhẹ nhàng hài hước hay rõ ràng và hợp lý. Điều đó phụ thuộc vào độc giả của bạn. Bạn nên dùng văn nói cho các tài liệu dạy trẻ cách làm thùng giấy chứ không nên dùng trong hướng dẫn dành cho bác sĩ cách phẫu thuật tim. Xác định giọng văn ngay từ đầu và thống nhất trong toàn bộ tài liệu hướng dẫn.
  2. Thực hiện theo từng bước bạn đã viết. Khi bạn thực hiện từng bước một, lời hướng dẫn của bạn sẽ không chỉ thành thực và đáng tin hơn, mà còn giúp bạn không bỏ sót bước nào.
    • Nếu vì một vài lý do nào đó, bạn khó có thể thực hiện các bước, hãy nghĩ kỹ lại và nhờ ai đó là chuyên gia tư vấn giúp.
  3. Số lượng các bước. Các bước đánh số giúp mọi người dễ dàng theo dõi và xem lại nếu họ mất phương hướng.
    • Nếu bạn viết lên giấy, hãy để khoảng trống giữa mỗi bước. Nên nhớ đánh số lại nếu bạn thêm bước nào đó.
  4. Thêm lời khuyên và cảnh báo. Khi viết, bạn có thể nhận ra vấn đề sẽ nảy sinh nếu người dùng thực hiện không cẩn thận.
    • Ngược lại, nếu có kiến thức nào giúp người dùng sử dụng dễ dàng và thú vị hơn, hãy bổ sung thêm.
  5. Thực hành lại. Chỉ dùng hướng dẫn bạn đã viết ra, làm đúng theo những gì nêu trong đó. Nếu bạn phát hiện ra những phần còn thiếu trong lời hướng dẫn của mình, hãy thêm các thông tin cần thiết. Lặp lại bước này cho đến khi bạn đã có đầy đủ các bước và có thể thực hiện theo đúng những gì mình viết mà không cần phải thêm lưu ý nào.
    • Có thể nhờ một hoặc hai người bạn sử dụng hướng dẫn trước. Cẩn thận theo dõi cách họ sử dụng sản phẩm. Xem họ lướt qua nhanh ở đâu. Xem họ bị mất phương hướng, khó hiểu hay không thể thực hiện ở bước nào. Lắng nghe họ nói, sau đó điều chỉnh lại hướng dẫn tương ứng.
  6. Đọc lại hướng dẫn. Bạn không nên gửi bản cuối cùng cho người hiệu đính (dù đó là cơ quan hoặc vợ chồng của bạn) lại là một bản hướng dẫn đầy lỗi.

Cách trình bày[sửa]

  1. Bắt đầu từ trên xuống. Khi bạn đã có tất cả các bước chi tiết cần thiết, hãy xem qua toàn bộ hướng dẫn để tìm các tiêu đề phù hợp cho từng nhóm.
    • Đặt tên và ghi chú vị trí.
  2. Viết Mục lục, nếu có thể. Xem cách sắp xếp của wikiHow làm ví dụ. Trang chính sẽ nêu các tiêu đề của từng phần. Khi bạn đi vào từng phần, sẽ có các nhóm nhỏ và trong các nhóm nhỏ sẽ liệt kê các đề mục. Hướng dẫn của bạn càng chi tiết, bạn càng cần nhiều các nhóm lớn và nhóm nhỏ. (Vi dụ viết về Cách Huýt sáo không cần phải có, Cách Khắc Ống sáo sẽ cần một vài, và Cách Chơi ống sáo sẽ cần rất nhiều!)
  3. Hiệu đính lại. Đúng vậy, bạn đã làm qua một lần rồi. Nhưng làm lần hai bạn sẽ vẫn có thể phát hiện ra những lỗi nhỏ hoặc những điểm chưa rõ ràng.
    • Để có một bản hướng dẫn kĩ hơn, bạn có thể nhân cơ hội này ghi chú lại toàn bộ những chủ đề nhỏ, và dùng thông tin đó để tạo một mục lục.
  4. Chọn tiêu đề.

Lời khuyên[sửa]

  • Dù bạn đã hiểu rõ vấn đề nào đó rồi, nhưng hãy cứ viết ra từng bước. Bạn sẽ tránh bỏ sót những phần người sử dụng chưa biết. Cung cấp thêm thông tin vẫn tốt hơn là bỏ qua những bước quan trọng.
  • Nếu bạn định viết một bản hướng dẫn rất chi tiết và cần phải chia thành các chương, như Cách chơi sáo, thì bước đầu tiên bạn nên làm là liệt kê tất cả các chương, như Chọn một cây sáo, Lắp và Bảo quản, Tạo Âm, Phương pháp Đặt tay, Tác phẩm đầu tiên v.v. Sau đó bạn cần áp dụng những quy tắc cơ bản khi viết lời hướng dẫn cho mỗi chương, vì mỗi chương tự nó cũng giống như một tài liệu hướng dẫn!
  • Bất cứ khi nào có thể, hãy minh họa cho lời hướng dẫn của bạn! Nếu bạn không thể chèn ảnh, hãy tìm những hình ảnh chung chung để làm ví dụ. Ví dụ, ở phần Cách trình bày, Bước 2 trong hướng dẫn này, dàn ý của wikiHow được dùng để minh họa cho cách tạo Mục lục.
  • Viết mỗi phần trên một tờ giấy riêng (hoặc trên máy tính) sẽ giúp bạn chỉnh sửa dễ dàng hơn. Bạn có thể sắp xếp lại nếu bạn cần thêm thông tin cũng như có thể tìm các điểm mình chỉnh sửa. Trên máy tính hãy để cách ra 3 hoặc 4 dòng (bằng cách nhấn enter (xuống dòng) vài lần) giữa các bước thì bạn có thể dễ dàng tìm thấy các chỗ ngắt.
  • Nếu bạn có thể, hãy nhờ một người mới học việc dùng thử bản hướng dẫn của bạn và viết ra các câu hỏi họ cần hỏi! Từ đó, bạn sẽ có thể điền vào những khoảng trống và giúp tài liệu của mình trở nên hữu ích hơn.

Liên kết đến đây