Cách viết hướng dẫn sử dụng

NộI Dung

• giai đoạn
• Phần 1 Làm quen với chủ đề
• Phần 2 Xây dựng kế hoạch hướng dẫn sử dụng của bạn
• Phần 3 Bắt đầu viết
• Định dạng phần 4

Viết hướng dẫn sử dụng có vẻ khó khăn, nhưng nó dễ hơn bạn nghĩ! Các bước này áp dụng cho bất kỳ sản phẩm bằng văn bản nào, từ đơn giản nhất (cách dạy mọi người tán thưởng cùng một lúc) đến phức tạp hơn (cách tạo ra chất bán dẫn).

giai đoạn

Phần 1 Làm quen với chủ đề

1. Đó là điều cần thiết! Điều này có vẻ rõ ràng, nhưng kiến ​​thức về chủ đề này là chìa khóa cho một hướng dẫn thành công. Ví dụ: nếu bạn đang viết hướng dẫn sử dụng máy ảnh, không chỉ biết rằng khẩu độ tương đối và thời gian phơi sáng là hai chức năng khác nhau, mà còn cách chúng tương tác sẽ giúp mô tả từng chức năng như một phần của nó dễ dàng hơn. của tất cả mọi thứ.

2. 
   

   
   Bao quanh mình với các chuyên gia. Nếu vai trò của bạn chỉ là viết và bạn không phải là chuyên gia trong lĩnh vực này, hãy sử dụng những người có kiến ​​thức mạnh về chủ đề này trong khi viết và đảm bảo họ đọc tác phẩm của bạn. Kiến thức và lời khuyên của họ là vô giá.

3. 
   

   
   
   
   Hãy thử một cách tiếp cận lĩnh vực. Nếu có thể, thực hành cho mình những gì bạn sắp mô tả sẽ cung cấp cho bạn, ít nhất, một ý tưởng về những gì người dùng muốn tìm hiểu.

4. 
   

   
   Nghiên cứu kỹ chủ đề. Tìm hiểu biệt ngữ, và làm quen với điều bạn đang viết.
   • Sách giáo khoa của các sản phẩm tương tự sẽ hướng dẫn bạn về cách các nhà văn khác đã tấn công chủ đề này.
     • Tìm kiếm sự tương đồng giữa các tác giả. Điều này sẽ cho bạn biết cả các tính năng phổ biến nhất và các phương pháp phổ biến để mô tả chúng.
     • Hãy tìm sự khác biệt rõ ràng. Chúng có thể làm nổi bật các chức năng cụ thể của một sản phẩm nhất định. Sản phẩm của bạn có thể có hoặc không có các tính năng này hoặc cung cấp các giải pháp khác nhau để giải quyết cùng một vấn đề. Trong trường hợp này, tốt hơn là mô tả chúng, điều này sẽ mang lại nhiều giá trị hơn cho sản phẩm của bạn. Mặc dù công việc của bạn là viết một cuốn sách công việc, nhưng việc giải thích cho khách hàng về giá trị thực sự của việc mua hàng của họ có thể khuyến khích họ tiếp tục đọc.
   • Trở thành một fan hâm mộ của các tạp chí thương mại. Tìm hiểu làm thế nào mọi người sử dụng sản phẩm phục vụ cuộc sống hàng ngày của họ. Có thể họ mơ về một tính năng có thể giải quyết vấn đề cụ thể của họ và nếu sản phẩm của bạn chứa giải pháp, nó xứng đáng được nhấn mạnh.

Phần 2 Xây dựng kế hoạch hướng dẫn sử dụng của bạn

1. 
   

   
   
   
   Phá vỡ. Cho dù đó là một lời giải thích chi tiết đơn giản, hoặc hướng dẫn sử dụng cho máy ảnh kỹ thuật số 35mm, việc chia nó thành các phần nhỏ hơn, dễ tiêu hóa hơn có một số lợi thế.
   • Điều này cho phép bạn tập trung vào các phần khác nhau của một tổng thể. Mục tiêu của bạn là giúp người dùng làm quen với việc học một chức năng. Cách để thực hiện chức năng một cách hiệu quả có thể được mô tả trong một hướng dẫn ở cuối, nếu cần hoặc để lại cho các thí nghiệm của người dùng.

2. 
   

   
   Thực hiện theo một trình tự hợp lý. Chẳng hạn, sẽ không khôn ngoan lắm khi mô tả cách đèn flash hoạt động trên máy ảnh trước khi giải thích cách lắp ống kính, đặt phim, bật máy ảnh và điều chỉnh độ sắc nét. Điều này đặc biệt áp dụng trong trường hợp bạn không biết rõ về chủ đề này.

3. 
   

   
   Sử dụng này làm mẫu cho mục lục của bạn.

4. 
   

   
   Kiểm tra các bước. Khi bạn đã xác định các phần logic, hãy xem lại chúng để đảm bảo bạn không quên bất cứ điều gì.

5. 
   

   
   Thu thập thiết bị của bạn. Giữ các mục bạn đã mô tả tiện dụng và sẵn sàng để sử dụng như được mô tả trong hướng dẫn. Nếu bạn làm một hộp giấy, hãy lên kế hoạch cho giấy, kéo, băng keo, keo dán và một quy tắc. Nếu bạn đang viết về máy ảnh, hãy đảm bảo máy ảnh của bạn được tháo rời hoàn toàn. Nếu có thể, hãy thay thế sản phẩm mà bạn viết trong hộp của nó.

Phần 3 Bắt đầu viết

1. 
   

   
   Nhập phần giới thiệu. Điều này sẽ đặt âm cho toàn bộ hướng dẫn và sẽ đưa ra ý tưởng cho người dùng về loại hướng dẫn sử dụng mà anh ta sắp đồng hóa. Ánh sáng và niềm vui, hay đơn giản và cụ thể? Nó phụ thuộc vào khán giả của bạn. Trò chơi chữ sẽ phù hợp hơn nếu bạn giải thích cho trẻ cách làm hộp giấy so với trường hợp bạn mô tả với bác sĩ về cách tiến hành phẫu thuật tim hở. Thiết lập một giai điệu từ đầu và giữ nó trong suốt hướng dẫn.

2. 
   

   
   Hoàn thành mỗi bước khi bạn viết. Điều này không chỉ mang lại cho bài viết của bạn một cái nhìn trung thực và xác thực, mà còn đảm bảo với bạn rằng không có gì sẽ rơi bên đường.
   • Nếu, vì lý do này hay lý do khác, không thể hoàn thành các bước, hãy tưởng tượng chúng cẩn thận và tham khảo ý kiến ​​một chuyên gia.

3. 
   

   
   Đánh số các bước. Mọi người theo cách này dễ dàng hơn và có thể quay lại điểm cụ thể nếu họ mất trang.
   • Nếu bạn làm việc trên giấy, hãy chừa không gian cho các bổ sung giữa mỗi bước. Hãy nhớ đánh số lại thủ tục nếu bạn cần thêm một cái gì đó.

4. 
   

   
   Chèn lời khuyên và cảnh báo. Khi viết, bạn nên lưu ý rằng nếu người dùng bất cẩn thực hiện một bước, điều này có thể gây ra sự cố.
   • Ngược lại, nếu biết một khía cạnh cụ thể có thể làm cho nhiệm vụ của người dùng dễ dàng hơn hoặc thú vị hơn, hãy thêm nó vào.

5. 
   

   
   Làm một bài kiểm tra. Bằng cách chỉ làm theo hướng dẫn của bạn, hoàn thành điều bạn đang nói. Nếu bạn nhận ra rằng giải thích bị thiếu, hãy thêm thông tin cần thiết. Lặp lại cho đến khi bạn đã mô tả tất cả các bước và có thể làm những gì bạn giải thích mà không cần phải thêm bất cứ điều gì.
   • Xem xét việc hướng dẫn kiểm tra bởi bạn bè. Xem chúng cẩn thận khi họ học cách sử dụng sản phẩm. Thực hiện các bước mà họ hoàn thành nhanh chóng. Cũng lưu ý nơi chúng bị mắc kẹt, mất phương hướng hoặc không thể thực hiện nhiệm vụ. Lắng nghe những gì họ đang nói, sau đó nâng cấp hướng dẫn của bạn cho phù hợp.

6. 
   

   
   Xem lại hướng dẫn của bạn. Bạn không muốn gửi cho người đánh giá cuối cùng của mình (cho dù là cơ quan của bạn hoặc vợ của bạn) một hướng dẫn chứa đầy lỗi sai.

Định dạng phần 4

1. 
   

   
   Có một tầm nhìn với nhau. Khi bạn đã chi tiết tất cả các bước cần thiết, hãy xem hướng dẫn của bạn để xác định các dòng quan trọng nhất.
   • Cung cấp cho họ một tiêu đề, và lưu ý vị trí của họ.

2. 
   

   
   Viết một Mục lục, nếu cần thiết. Quan sát cách được xây dựng chẳng hạn. Trang chủ có các phần khác nhau. Khi bạn chọn một, trang web sẽ trình bày các danh mục con khác nhau và các bài viết tương ứng. Hướng dẫn sử dụng của bạn càng chi tiết, bạn càng cần nhiều danh mục và danh mục con. ("Cách huýt sáo" yêu cầu một người, "Cách điều chỉnh tiếng còi" sẽ yêu cầu một số người và "Cách thổi sáo" sẽ đòi hỏi nhiều hơn thế!)

3. 
   

   
   Đọc lại tài liệu của bạn. Vâng, bạn đã làm rất kỹ lưỡng. Làm điều đó lần thứ hai chắc chắn sẽ tiết lộ một số lỗi nhỏ hoặc đoạn văn mà hướng dẫn của bạn không rõ ràng.
   • Để có hướng dẫn toàn diện hơn, bạn có thể chọn từng chủ đề nhỏ và sử dụng chủ đề đó để tạo chỉ mục.

4. 
   

   
   Chọn một tiêu đề.

• Bất cứ khi nào có thể, minh họa giải thích của bạn! Nếu bạn không thể chèn hình ảnh, hãy giới thiệu học sinh của bạn đến một ví dụ phổ biến. Ví dụ, trong phiếu tự đánh giá Định dạng, giai đoạn 2 trong những giải thích này, chúng tôi sử dụng sự xuất hiện của kế hoạch để minh họa cách tạo ra một Mục lục.
• Nếu bạn có thể, hãy kiểm tra hướng dẫn của bạn bởi một người mới và viết ra từng câu hỏi! Điều này sẽ giúp bạn điền vào các khoảng trống và làm cho hướng dẫn của bạn hữu ích hơn nhiều.
• Ngay cả khi một điều có vẻ rõ ràng với bạn, hãy chia nhỏ các bước! Điều này có thể cứu bạn khỏi việc nhanh chóng vượt qua một cái gì đó mà người dùng không biết. Tốt hơn là thêm thông tin thay vì bỏ qua các bước quan trọng.
• Nếu bạn đang viết một hướng dẫn rất chi tiết yêu cầu các chương, ví dụ: "Cách thổi sáo", trước tiên bạn nên liệt kê tất cả các chương, chẳng hạn như "chọn sáo", "Lắp ráp và bảo trì", "Sản xuất một âm thanh "," Phương pháp đặt ngón tay "," Mảnh đầu tiên của bạn ", v.v. Sau đó, bạn sẽ áp dụng phương pháp cơ bản để viết hướng dẫn sử dụng trong mỗi chương, vì mỗi chương có chức năng như một cuốn sách giáo khoa đầy đủ!
• Viết mỗi phần trên một trang khác nhau (hoặc trên máy tính) sẽ giúp chỉnh sửa dễ dàng hơn. Các thay đổi sẽ dễ dàng hơn nếu bạn có chỗ và có thể tìm thấy vòng bi của mình. Trên máy tính, để lại 3 hoặc 4 dòng lối vào nhiều lần) giữa mỗi bước để tìm sự gián đoạn dễ dàng.