Tài liệu sản phẩm
Giúp người dùng hoàn thành các tác vụ mà ứng dụng của bạn hỗ trợ
Cung cấp cho người dùng các hướng dẫn thực tế giải thích các quy trình của ứng dụng và giúp họ hoàn thành các nhiệm vụ.
Hướng dẫn sử dụng các tính năng sản phẩm một cách thực tế
- Chuẩn bị phạm vi của ống ngắm
Xem lại các phần tài liệu và đối tượng mà chúng hướng đến.
- Trả lời các câu hỏi về nội dung
Làm rõ quy trình và thông tin mà hướng dẫn nên giải thích.
- Hãy tuân theo hướng dẫn của dịch vụ công cộng.
Kiểm tra tiến độ xây dựng và địa chỉ trang web tài liệu.
Hướng dẫn cách sử dụng ứng dụng.
Tài liệu bổ sung cho bản trình bày sản phẩm bằng các hướng dẫn thực tế. Bắt đầu bằng phần hướng dẫn sử dụng, sau đó hướng dẫn người dùng qua các quy trình mà ứng dụng thực sự hỗ trợ.
Cấu hình tài liệu hiển thị các định nghĩa phần và câu hỏi. Cung cấp ngữ cảnh giúp giải thích một nhiệm vụ bằng ngôn ngữ của người dùng.
Giữ hướng dẫn kết nối với ứng dụng đang chạy
Hỗ trợ một hành động hữu ích đầu tiên. Hướng dẫn bắt đầu giúp người dùng mới nhanh chóng làm quen với sản phẩm. Hướng dẫn này nên giải thích bắt đầu từ đâu, cần những thông tin gì và kết quả nào xác nhận rằng nhiệm vụ đã hoàn thành.
Giải thích quy trình làm việc lặp đi lặp lại. Hướng dẫn chi tiết tuân theo nhãn và hành động thực tế của ứng dụng. Các điều kiện tiên quyết, các bước được đánh số và kết quả mong muốn giúp người dùng lặp lại một tác vụ kinh doanh mà không cần diễn giải một mô tả chung về màn hình.
Trả lời một câu hỏi bao quát. Một số câu hỏi liên quan đến tài khoản, chi phí hoặc quy trình xuất bản thay vì chỉ một màn hình. Câu hỏi thường gặp cung cấp câu trả lời ngắn gọn và liên kết đến hướng dẫn liên quan, giữ cho quy trình ở một nơi thay vì lặp lại trên toàn trang web.
Giữ các hướng dẫn kết nối với sản phẩm
Xem lại tài liệu sau khi có thay đổi đáng kể trong ứng dụng. Hướng dẫn nên sử dụng các nhãn và hành vi mà người dùng thực sự có thể thấy.
Tài liệu được chạy trên một dịch vụ công khai riêng biệt. Liên kết từ trang web và kiểm tra các hướng dẫn bằng các ngôn ngữ mà dự án của bạn hỗ trợ.
Giúp người dùng hoàn thành tác vụ tiếp theo
Một hướng dẫn thực tế giải thích nên bắt đầu từ đâu, cần thông tin gì và cách kiểm tra kết quả. Giá trị của nó nằm ở việc giúp người đọc thao tác được trong ứng dụng.
Dùng các hướng dẫn liên quan để tiếp tục hành trình khi tác vụ trải qua nhiều khu vực. Hãy xem lại tài liệu khi một màn hình thay đổi để các chỉ dẫn vẫn hữu ích sau mỗi lần cập nhật.
Từ các chức năng đã thống nhất đến sự hỗ trợ hữu ích
Chuẩn bị ống ngắm.. Xem lại các phần trong tài liệu và các tác vụ mà chúng nên giải thích. Hãy giữ cho đối tượng người dùng và hành vi ứng dụng luôn rõ ràng.
Cung cấp thông tin còn thiếu.. Trả lời các câu hỏi về điều kiện tiên quyết, quy tắc và kết quả. Nội dung nên sử dụng giao diện thực tế thay vì các điều khiển được tạo ra.
Xem lại sau khi xuất bản và chỉnh sửa. Làm theo hướng dẫn trong ứng dụng, kiểm tra ngôn ngữ và các liên kết liên quan, sau đó xem lại khi nhiệm vụ cơ bản thay đổi.
Giúp sản phẩm dễ sử dụng hơn sau lần dùng đầu tiên
Cung cấp các hướng dẫn dẫn đến một kết quả, cùng với phần trình bày công khai về những gì ứng dụng thực hiện.
Các câu hỏi về tài liệu sản phẩm
Một trang tính năng giúp khách hàng tiềm năng hiểu rõ hơn về khả năng và giá trị của sản phẩm. Một hướng dẫn giúp người dùng thực hiện một tác vụ, với các điều khiển, yêu cầu và kết quả thực tế. Chúng bổ sung cho nhau.
Các công cụ tài liệu hiển thị định nghĩa phần và câu hỏi. Xem lại các tác vụ mà ứng dụng hỗ trợ, cung cấp thông tin còn thiếu và theo dõi tiến trình viết.
Dự án xuất bản các hướng dẫn đã được bản địa hóa cho phạm vi của nó. Xem xét từng ngôn ngữ đã xuất bản để đảm bảo rằng nó vẫn giữ nguyên quy trình đầy đủ và các nhãn giao diện chính xác.
Sau khi có thay đổi ảnh hưởng đến tác vụ, các điều khiển hoặc kết quả mong đợi, hãy kiểm tra văn bản so với ứng dụng đang hoạt động thay vì giả định rằng các hướng dẫn ban đầu vẫn còn hiệu lực.
Một tham chiếu điểm cuối thuộc về một dự án có API đang hoạt động. Sử dụng các hoạt động trực tiếp và tham chiếu thực tế của nó; các tuyến đường được lên kế hoạch là không đủ để ghi lại một tích hợp có thể sử dụng.