Tài liệu tham khảo tốt cho các ví dụ về tài liệu Người dùng Cuối và tư vấn [đã đóng]

Phần mềm nội bộ của chúng tôi đã được sử dụng cho nhiều người dùng và bộ phận đào tạo đã hỏi chúng tôi bất kỳ lời khuyên nào về định dạng tài liệu người dùng cuối.

Có ai biết tôi có thể tìm thấy các ví dụ tốt về tài liệu người dùng cuối phần mềm mà bộ phận đào tạo sử dụng để lấy cảm hứng hoặc bất kỳ trang web nào có lời khuyên tốt không?

Điều này tương tự với câu hỏi này tuy nhiên tôi đang tìm tài liệu người dùng cuối để sử dụng cho người dùng không có kỹ thuật.

Bạn có thể muốn bắt đầu bằng cách phỏng vấn người dùng nội bộ về phần mềm và tìm hiểu loại thông tin họ muốn biết.

Phần lớn tài liệu tôi viết về phần mềm đã có một hoặc nhiều đối tượng trong tâm trí. Bộ phận đào tạo của bạn có thể sẽ được hưởng lợi từ một bộ các chủ đề (như TOC). Vì vậy, sau đó bạn có thể thảo luận về những chủ đề có liên quan và những gì không liên quan đến mục tiêu đào tạo của họ.

Một số chủ đề có thể bao gồm:

1. Đối tượng mục tiêu
2. Yêu cầu kỹ thuật
3. Cách cài đặt (nếu có)
4. Quá trình (tức là phần mềm thực hiện chức năng kinh doanh nào?)
5. Tính năng (phần mềm có những tính năng gì?)
   • Bạn có thể có một cách tiếp cận dựa trên nhiệm vụ cho việc này, ví dụ: Thêm người dùng hoặc Thêm tài liệu
   • Bạn có thể có một cách tiếp cận dựa trên đối tượng, ví dụ: Người dùng, Vai trò
   • Bạn có thể có một cách tiếp cận dựa trên Menu, ví dụ: Menu File, View Menu
6. Cuối cùng, có thể phần Tính năng và Câu hỏi thường gặp sắp tới có thể hoạt động như một kho lưu trữ kiến ​​thức đang phát triển của sản phẩm của bạn.

Cố gắng dự đoán cách người dùng cuối của bạn sử dụng phần mềm của bạn, dựa trên kiến ​​thức về phát triển phần mềm, kiến ​​thức của bạn về những gì nó làm và cũng dựa trên (hy vọng) các cuộc phỏng vấn của bạn với người dùng cuối.

Quan trọng nhất, hãy cố gắng tạo tài liệu mà bạn muốn đọc, sử dụng tên ví dụ thú vị để trình bày và sử dụng nhiều ảnh chụp màn hình có chú thích.

Hi vọng điêu nay co ich

Tôi đã đọc một số "Hướng dẫn sử dụng cuối" và đã viết một và tôi nghĩ rằng có nhiều yếu tố giúp cải thiện hiệu quả của chúng:

• Hiển thị với hình ảnh như thế nào được ban hành một số lệnh hoặc thực hiện một số hành động (ví dụ: ảnh chụp màn hình).
• Tập trung vào sự cần thiết phải làm một cái gì đó, và cách để hoàn thành nó. Tránh xa các mô tả kỹ thuật về cách tối ưu hóa hành động đó được thực hiện chẳng hạn.
• Khi tôi đặt sơ đồ mô tả các mô-đun, phần mềm được chia và tôi nhận được nhận xét rằng nó không hữu ích.
• Cố gắng thấy trước các sự cố có thể xảy ra mà người dùng có thể gặp phải để phần Xử lý sự cố của bạn trở nên hữu ích. Bạn cũng phải kiểm tra chương trình của mình với những người dùng không liên quan đến sự phát triển của nó, ngay cả đồng nghiệp của bạn đã đánh thức các dự án khác.
• Tránh mô tả nhàm chán. Bất kỳ thông tin nào khác có thể được đưa vào một phụ lục hoặc một cái gì đó tương tự.

Tôi hy vọng điều này có thể hữu ích cho bạn.

Bạn đề cập rằng nó sẽ được sử dụng cho đào tạo.

Nếu bạn đang tìm kiếm một tài liệu đào tạo thay vì một tài liệu tham khảo, trang web yêu thích của tôi là hướng dẫn của Joel Spolsky về Mercurial tại đây .

1. Trình bày đơn giản, sạch sẽ. Thật tuyệt khi nhìn vào.
2. Có thẩm quyền, nhưng cá nhân trong giai điệu. Cảm giác như bạn đang ở trong một bài giảng đại học tuyệt vời.
3. Hình ảnh đơn giản, không nhiều ảnh chụp màn hình thực tế. Đọc Mặt sau của Napkin để biết lý do tại sao điều này hoạt động.

Nếu tài liệu đào tạo của bạn tuyệt vời bằng 1/2 so với hướng dẫn Mercurial của Joel, tôi sẽ đọc nó. Nhưng bạn cần một người có a) đam mê viết lách và b) một kiến ​​thức chuyên sâu đáng kinh ngạc để loại bỏ nó, ngay cả khi bạn có thể sao chép 3 điểm trên. Hy vọng nó hoạt động.

Tôi không biết điều này có thể phù hợp với nhu cầu của bạn không, nhưng có những hệ thống được sử dụng cho nhân sư tài liệu kỹ thuật là một trong những ý tưởng tạo điều kiện cho việc tạo tài liệu trực tuyến. Có thể một cái gì đó như thế này được sử dụng cho những gì bạn quan tâm?

Tôi cũng chỉ chạy trên ReadTheDocs , hoạt động tương tự nhưng là một giải pháp được lưu trữ.

Kiểm tra Hiệp hội truyền thông kỹ thuật (STC) . Nhiều người chiến thắng giải thưởng của họ đã viết sản xuất thường có sẵn. Họ cũng có thể có sẵn mẫu. Trở thành thành viên cũng sẽ cung cấp quyền truy cập vào một khối thông tin lớn hơn.