Triển khai tài liệu cho khách hàng

Mục đích

Khi triển khai trang web cho khách hàng, cần có hướng dẫn sử dụng. Phương pháp hiện tại là viết ra một tập các tài liệu gửi cho khách hàng. Phương pháp này có một hạn chế, đó là khách hàng sẽ phải mất thời gian tìm đúng mục cần tìm trong tài liệu. Thay vào đó, một phương pháp khác được đề xuất: ở mỗi màn hình (màn master, detail, trang chủ, vv...) sẽ gắn đường dẫn đến tài liệu dành cho màn hình đó.

Phương pháp

Hệ thống tài liệu

Tài liệu sẽ được viết và hệ thống trên BookStack này. Phân cấp trong BookStack được chia thành 3 level: Book > Chapter > Page. Mỗi màn hình sẽ có 1 tài liệu riêng đặt trong 1 Page riêng, có thể gom nhóm thành Chapter, tất cả được đặt trong 1 Book dành riêng cho trang web đó.

Triển khai tài liệu

Tính năng triển khai tài liệu được áp dụng trên Page

Khi truy cập 1 Page, sidebar sẽ có 2 Action riêng là Public và Public View

• Public: Cài đặt public URL cho Page
• View Public: Truy cập vào public URL đã được gán (chỉ hiển thị với Page đã được gán URL)

Khi được public, đường dẫn của Page sẽ có dạng https://bookstack.truesight.asia/public/[path], trong đó [path] là giá trị mà người dùng nhập trong màn hình cài đặt.

Sau khi cài đặt xong người dùng vào View Public để kiểm tra.