Skip to main content

[Editor] Hướng dẫn 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 đó.

image.png

Triển khai tài liệu

MỗiTính Pagenăng trêtriển BookStack sẽ được gắn một đường dẫn public ra ngoài để đưa vào trang web. Để quản lý đường dẫn này, truy cập vào trang Quản lý Tài liệu, đăng nhập bằng tài khoản Azure Devops.

image.png

Tại màn hình chính là danh sách các Page hiện có trên BookStack, trong đó:

  • Id: Id của trang tài liệu
  • Page URL: Đường dẫn đến trang tài liệu trên BookStack
  • Path: Đường dẫn đến trang tài liệu khi public ra ngoài
  • Registered: Trang tài liệu có được public ra ngoài hay không

Khi người dùng tạo/xóa/phục hồi/di chuyển tài liệu trên BookStack, bấm F5 để tải lại danh sách trên web Quản lý.

Nếu không tìm thấy tài liệu, chờ vài giây rồi tải lại trang lần nữa. Nếu vẫn không tìm thấy, liên hệ quản lý BookStack.

Người dùng có thể lọc tìm kiếm trang tài liệu của mình theo Page URL, Path và Registered. Bấm vào Apply để thực hiện lọc.

Ngoài ra người dùng có thể tải tài liệu về bằng Download ZIP. Chỉ áp dụng với tài liệu được public ra ngoài.

Một trangkhai tài liệu được áp dụng trên Page

image.png

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

  • Public: Cài đặt public raURL ngoàicho nếuPage
    • nó
  • Public View: Truy cập vào public URL đã được đăng ký Path và tick chọgán Registered.

    (chỉ

    Đểhiển chỉnhthị sửa thông tin public của tàvới liệu,Page bấmđã vàođược Edit.

    image.png

    Đường dẫgán public của tài liệu có dạng /<path>. Một số ví dụ:

    • /overview
    • /00.overview/01.glossary
    • /01.menu-order/01.tab-nguoi-dung/tong-quan
    • vv...URL)

    Bấmimage.png

    Save Changes

    Khi đểược lưu thông tin.

    Truy cập tài liệu

    Sau khi đăng ký public tài liệu,public, đường dẫn đếncủa tài liệu nàyPage sẽ có dạng https://docs.bookstack.truesight.asia/docspublic/[Path]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 Public View để kiểm tra.

    image.pngimage.png

    Bên trong trang tài liệu có Mục lục nằm bên trái dựa vào các Header bên trong tài liệu.

Back to top