Viết kỹ thuật – Làm thế nào để viết tài liệu kỹ thuật một cách nhất quán và tăng sự tự tin của người dùng?

Viết kỹ thuật – Làm thế nào để viết tài liệu kỹ thuật một cách nhất quán và tăng sự tự tin của người dùng?

Một hồ sơ kỹ thuật nhất quán sẽ tạo niềm tin và sự tin tưởng cho người dùng cuối. Tất cả bắt đầu với một mẫu. Không quan trọng bạn đang tạo một cuốn sách, một tệp trợ giúp hay một trang web. Một mẫu là cần thiết.

Khi bạn đã thiết kế và kiểm soát mẫu của mình, bạn nên tuân theo hướng dẫn về phong cách để tạo tài liệu mạch lạc và nhất quán.

Dưới đây là một số lời khuyên hữu ích:

Bắt đầu tất cả các danh sách có thứ tự (được đánh số) và không có thứ tự của bạn bằng một động từ hành động. “Nhập mật khẩu của bạn” “Hệ thống sẽ yêu cầu bạn nhập mật khẩu. Vui lòng làm như vậy.”

Một số hành động của người dùng trong tài liệu phần mềm đề cập đến việc người dùng nhấp vào một nút để hiển thị một màn hình cụ thể. Thực hiện theo cùng một mô hình bằng cách sử dụng cùng một câu ghép để mô tả hai hành động liên quan đó.

Ví dụ: “Nhấp vào nút Tiếp theo để hiển thị màn hình cấu hình.”

Bạn cũng có thể sử dụng mô hình đầu tiên này theo sau đó trong ngữ cảnh phần cứng:

Khác: “Đo điện áp trước khi kết nối dây để đảm bảo an toàn.”

Quyết định xem bạn muốn sử dụng “hộp kiểm” hay “hộp kiểm” và gắn bó với nó. Đừng chuyển đổi qua lại giữa hai cách sử dụng đó.

Điều tương tự cũng xảy ra với “hộp thả xuống” và “hộp thả xuống” hoặc “danh sách thả xuống”.

Các tiêu đề bảng thường đứng trước các bảng, trong khi các tiêu đề hình theo sau các hình. Đảm bảo rằng bạn nhất quán với cách sử dụng tiêu đề bảng và tiêu đề hình.

Không có quyền hay sai tuyệt đối về phong cách trong lĩnh vực kinh doanh này, và không có thứ gọi là “quá nhiều” nhất quán khi nói đến văn bản kỹ thuật. Điều quan trọng hơn là đưa ra quyết định về phong cách và định dạng và gắn bó với chúng.

*Bài viết theo quan điểm của tác giả: Ugur Akinci, chúng tôi chỉ biên dịch và giới thiệu

Bài viết liên quan

Trả lời

Email của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *