Xem thêm

Hướng dẫn viết tài liệu phần mềm chuyên nghiệp cho người dùng cuối

CEO Hùng PV
Viết tài liệu phần mềm cho người dùng cuối là một phần quan trọng trong quá trình phát triển phần mềm. Tuy nhiên, việc viết tài liệu không chỉ đơn giản là việc dịch thuần...

Viết tài liệu phần mềm cho người dùng cuối là một phần quan trọng trong quá trình phát triển phần mềm. Tuy nhiên, việc viết tài liệu không chỉ đơn giản là việc dịch thuần túy từ một ngôn ngữ sang ngôn ngữ khác. Việc viết tài liệu đòi hỏi khả năng phân tích sâu sắc về yêu cầu của người dùng, cung cấp thông tin một cách logic và hiệu quả.

Xác định lý do kinh doanh cho tài liệu của bạn.

Mặc dù chức năng chính của tài liệu phần mềm là giúp người dùng hiểu cách sử dụng ứng dụng, nhưng còn có nhiều lý do khác để viết tài liệu. Điều này bao gồm hỗ trợ tiếp thị phần mềm, nâng cao hình ảnh của công ty và giảm chi phí hỗ trợ kỹ thuật. Trong một số trường hợp, tài liệu cũng là cần thiết để tuân thủ các quy định hoặc yêu cầu pháp lý.

Tuy nhiên, tài liệu phần mềm không nên thay thế cho một giao diện người dùng kém. Thay vào đó, nếu một màn hình ứng dụng yêu cầu nhiều tài liệu để giải thích, thì tốt hơn hết nên thay đổi thiết kế màn hình thành một giao diện trực quan hơn.

Hiểu khán giả mà bạn đang viết tài liệu cho họ.

Trong hầu hết các trường hợp, người dùng phần mềm có ít kiến thức về máy tính ngoài việc sử dụng các chức năng mà ứng dụng cung cấp. Để xác định cách giải quyết nhu cầu của họ thông qua tài liệu, bạn có thể:

  • Nhìn vào chức danh công việc mà người dùng tiềm năng của bạn đang nắm giữ. Ví dụ, một quản trị viên hệ thống có thể là chuyên gia về một số ứng dụng phần mềm, trong khi nhân viên nhập dữ liệu chỉ biết cách sử dụng ứng dụng để nhập dữ liệu. Viết từ tổng thể đến chi tiết và tạo các flows ứng với từng vai trò người dùng.

  • Nhìn vào chính người dùng. Mặc dù chức danh công việc thường chỉ ra công việc mà mọi người làm, nhưng có thể có sự khác biệt về cách sử dụng một số chức danh trong một tổ chức cụ thể. Bằng cách phỏng vấn người dùng tiềm năng, bạn có thể biết xem ý kiến của họ về công việc của mình có chính xác hay không.

  • Xem tài liệu hiện có. Tài liệu cho các phiên bản trước của phần mềm và các thông số kỹ thuật cung cấp một số chỉ dẫn về những gì người dùng cần biết để sử dụng chương trình. Tuy nhiên, hãy nhớ rằng người dùng cuối không quan tâm đến cách hoạt động của chương trình mà họ chỉ quan tâm đến cách nó có thể giúp ích cho họ.

  • Xác định các nhiệm vụ cần thiết để thực hiện công việc và những nhiệm vụ nào cần hoàn thành trước khi thực hiện được những nhiệm vụ đó.

Xác định (các) định dạng thích hợp cho tài liệu.

Tài liệu phần mềm có thể được cấu trúc theo một trong hai định dạng: tài liệu tham khảo và hướng dẫn sử dụng. Đôi khi, kết hợp các định dạng này là cách tiếp cận tốt nhất.

  • Định dạng hướng dẫn tham khảo giải thích các tính năng riêng biệt của một ứng dụng phần mềm (nút, tab, trường và hộp thoại) và cách chúng hoạt động. Nhiều tài liệu trợ giúp được viết theo định dạng này, đặc biệt là trợ giúp theo ngữ cảnh hiển thị chủ đề có liên quan bất cứ khi nào người dùng nhấp vào nút Trợ giúp trên một màn hình cụ thể.

  • Định dạng hướng dẫn sử dụng giải thích cách sử dụng phần mềm để thực hiện một tác vụ cụ thể. Hướng dẫn sử dụng thường được định dạng dưới dạng hướng dẫn in hoặc file PDF, mặc dù một số file trợ giúp cũng bao gồm các chủ đề về cách thực hiện các tác vụ cụ thể.

Quyết định (các) định dạng tài liệu sẽ có.

Tài liệu phần mềm dành cho người dùng cuối có thể có một hoặc nhiều định dạng, bao gồm sách hướng dẫn in, tài liệu PDF, file trợ giúp hoặc trợ giúp trực tuyến. Mỗi định dạng được thiết kế để chỉ cho người dùng cách sử dụng từng chức năng của chương trình. Trong trường hợp file trợ giúp và trợ giúp trực tuyến, điều này có thể bao gồm cả video trình diễn và văn bản đồ họa.

Các file trợ giúp và trợ giúp trực tuyến cần được lập chỉ mục và có khả năng tìm kiếm từ khóa để người dùng có thể nhanh chóng tìm thấy thông tin mà họ đang tìm kiếm. Vì vậy, tạo chỉ mục theo cách thủ công sẽ hiệu quả hơn việc sử dụng các công cụ tự động tạo chỉ mục.

Chọn công cụ tài liệu thích hợp.

Hướng dẫn sử dụng bản in hoặc file PDF có thể được viết bằng các công cụ như MS Word, Google Docs hoặc các trình soạn thảo văn bản phức tạp như FrameMaker, tùy thuộc vào bản chất và độ phức tạp của tài liệu. File trợ giúp có thể được viết bằng công cụ tạo trợ giúp như RoboHelp, Help và Manual, Doc-To-Help, Flare, HelpLogix hoặc HelpServer.

Câu hỏi và câu trả lời của cộng đồng

Có bất kỳ công cụ miễn phí nào cho tài liệu phần mềm không? Một số công cụ miễn phí mà bạn có thể sử dụng để tạo tài liệu phần mềm bao gồm Doxygen để tạo các trang hướng dẫn dạng web và LaTeX để xuất ra file PDF.

Tôi đã thấy các lần nhấn phím được ghi lại ở nhiều định dạng khác nhau. Có một tiêu chuẩn chung hay tất cả chúng đều khác nhau? Hiện tại không có tiêu chuẩn chung cho các lần nhấn phím trong tài liệu phần mềm. Tuy nhiên, bạn nên đặt tiêu chuẩn riêng cho tài liệu của mình. Để có một số ý tưởng, bạn có thể tham khảo Hướng dẫn tạo kiểu của Microsoft và Hướng dẫn kiểu của Apple. Chúng có các phong cách khác nhau, vì vậy nếu bạn viết tài liệu đa nền tảng, bạn có thể kết hợp các phong cách từ cả hai hướng dẫn.

Lời khuyên

  • Văn bản phải được sắp xếp một cách rõ ràng và dễ đọc. Đồ họa nên được sử dụng để tạo sự tương tác giữa văn bản và hình ảnh. Chia nhỏ tài liệu thành các phần và chủ đề hợp lý. Mỗi phần hoặc chủ đề nên giải quyết một vấn đề cụ thể hoặc một tính năng của chương trình.

  • Bất kỳ công cụ tài liệu nào được liệt kê ở trên có thể được bổ sung bằng công cụ tạo ảnh chụp màn hình như Snagit nếu tài liệu yêu cầu sử dụng ảnh chụp màn hình. Ảnh chụp màn hình nên được sử dụng để giải thích cách hoạt động của phần mềm một cách rõ ràng mà không làm cho người dùng bị lạc hướng.

Những công cụ cần thiết cho việc viết tài liệu

  • Công cụ thiết kế phần mềm như MS Word, Google Docs.
  • Template tài liệu chuẩn từ các dự án trước của công ty.
  • Công cụ tạo ảnh chụp màn hình như Snagit.

Nguồn: wikicell

1