Cách viết hướng dẫn rõ ràng

Mục lục:

Anonim

Nhiều người sẽ không đọc hướng dẫn ngoại trừ như là phương sách cuối cùng. Một khi mọi người đọc chúng, chúng chỉ hữu ích nếu chúng được viết bằng ngôn ngữ rõ ràng, súc tích. Khi bạn hiểu đối tượng của mình, bạn sẽ được chuẩn bị tốt hơn để giới thiệu, theo hướng dẫn.

Nghiên cứu đối tượng của bạn

Các hướng dẫn thường cho người đọc biết cách làm, xây dựng, vận hành hoặc bảo trì sản phẩm hoặc quy trình. Đầu tiên, đủ điều kiện đối tượng dự định của bạn để biết họ hiểu chủ đề tốt như thế nào. Ví dụ: nếu bạn viết hướng dẫn viết cho nhân viên mới, họ nên viết bằng ngôn ngữ đơn giản, trong khi hướng dẫn cho quản lý cấp cao có thể bao gồm nhiều biệt ngữ trong ngành. Sử dụng ngôn ngữ phù hợp với người đọc và bao gồm nhiều chi tiết mà họ cần để thực hiện nhiệm vụ.

Tạo phần giới thiệu

Rất thường người đọc bỏ qua phần giới thiệu tường thuật và chuyển ngay vào hướng dẫn. Một cách để giúp người đọc chuyển qua phần giới thiệu là viết một lời giải thích hoặc lý do cho các hướng dẫn trong một danh sách được đánh số thay vì dạng đoạn văn. Độc giả có nhiều khả năng để xem lại danh sách. Bao gồm mục đích của các hướng dẫn, ai nên đọc tài liệu và những gì nó bao gồm, mỗi mục dưới một tiêu đề riêng biệt. Phần giới thiệu này cũng cung cấp cho độc giả một manh mối về những gì không được đề cập.

Sử dụng giọng nói hoạt động

Không sử dụng giọng nói thụ động, chẳng hạn như, Dây trắng nên được cắm vào phích cắm A. Thay vào đó, hãy viết hướng dẫn dưới dạng các lệnh yêu cầu giọng nói hoạt động, chẳng hạn như Chèn Chèn dây trắng vào phích cắm A. Cho dù bạn đang viết danh sách, một câu chuyện hoặc một cuốn sách nhỏ, chia các câu dài với nhiều bước thành các hướng dẫn ngắn gọn được liệt kê dưới tiêu đề. Chia các câu bao gồm các từ "và" thành các câu riêng biệt ngắn hơn. Thay vì viết, Cáp nên được nối và đặt vào ổ cắm màu đỏ, hãy viết hai câu bắt đầu bằng các động từ hành động, chẳng hạn như Cáp Splice cáp. Đặt cáp nối vào ổ cắm màu đỏ. Một tiêu đề rõ ràng, táo bạo có thể nói điều gì đó giống như Hook Hook Up the Wires.

Hành động riêng biệt từ thông tin giải thích

Rất thường xuyên, hướng dẫn cũng cần giải thích. Viết bình luận giải thích theo một trong hai cách. In đậm các hướng dẫn thực tế để chúng nổi bật hoặc cung cấp giải thích trong một cột riêng để tham khảo. Một chiến thuật là đặt các bước trên một mặt của tài liệu, với các giải thích trong một đoạn ngắn trong một cột cạnh nhau. Một cách khác, hiệu quả hơn là in đậm các hướng dẫn thực tế và hoàn thành bước bằng cách viết lời giải thích. Ví dụ, tôn Nhấn nút màu đỏ trong ba giây (in đậm). Điều này sẽ cho phép ánh sáng kích hoạt.