Giao diện
[Tên module / tính năng] ​
Đây là KHUNG CHUẨN (source of truth) cho user guide — skill
ba/.claude/skills/generate-user-guide/SKILL.mdtrỏ tới file này ở Bước 2. Sửa cấu trúc template thì sửa Ở ĐÂY. Gồm 4 section cố định: I. Thông tin chung / II. Hướng dẫn chi tiết / III. Lưu ý & Quy tắc nghiệp vụ / IV. Các Lỗi Thường Gặp & Cách Xử Lý. Section II: mỗi hành động ={% details summary="[Tên hành động]" %}bọc TRỌN — bên trong theo thứ tự: Kết quả → hint warning/danger (nếu có) →{% stepper %}...{% endstepper %}→ hint success — đóng{% enddetails %}sau success. KHÔNG dùng heading### N.cho hành động. (Đây là{% details %}tag GitBook — import OK; KHÁC thẻ HTML<details>.) Ảnh:đứng một mình, có dòng trống trên/dưới — caption viết vào alt text (GitBook tự hiển thị). KHÔNG dán dòng*italic*dưới ảnh (→ ảnh hiển thị bé), KHÔNG dùng<figure>. Thiếu ảnh →<!-- TODO: screenshot: <tên-file>.png -->. 3 dòng chú thích>này KHÔNG phải nội dung tài liệu — bỏ đi khi tạo file user guide thật.
Record of changes ​
A – Add / M – Modify / D – Delete
| Effective Date | Update Person | A,M,D | Change Description | Version |
|---|---|---|---|---|
| [DD/MM/YYYY] | [Tên BA] | A | Khởi tạo tài liệu | v1.0.0 |
I. Thông tin chung ​
Thông tin
Dành cho: [Nhóm người dùng — ví dụ: Admin, SX, Ops] Đường dẫn: [URL đầy đủ đến module]
Thông tin
Phạm vi & Module liên quan ​
- Module chính: [Tên module]
- Module liên quan: [Module A], [Module B]
- Hệ thống tích hợp: [Tên hệ thống – nếu có]
Lưu ý
Điều kiện tiên quyết ​
- [Điều kiện 1 — ví dụ: Đã đăng nhập và được cấp quyền truy cập module]
- [Điều kiện 2 — nếu có]
II. Hướng dẫn chi tiết ​
Xem danh sách & chi tiết
Kết quả: [Người dùng thấy được gì sau khi thực hiện]
[Mở màn hình danh sách] ​
[Mô tả thao tác — đường dẫn menu, tab cần chọn]. Danh sách hiển thị với các cột:
| Cột | Mô tả |
|---|---|
| [Tên cột 1] | [Ý nghĩa] |
| [Tên cột 2] | [Ý nghĩa — ghi rõ điều kiện hiển thị/khả dụng nếu có] |
Ảnh chưa có: Màn hình danh sách [Tên sub-module] screenshots/01-%3Crole%3E-danh-sach.png
[(Tùy chọn) Tìm kiếm / lọc] ​
[Mô tả điều kiện tìm kiếm, nút Search / Reset]
[Mở chi tiết] ​
[Mô tả thao tác mở record cần xem]. Màn chi tiết hiển thị các trường:
| Trường | Mô tả |
|---|---|
| [Tên trường 1] | [Ý nghĩa — ghi rõ định dạng/điều kiện hiển thị nếu có] |
| [Tên trường 2] | [Ý nghĩa] |
Ảnh chưa có: Màn hình chi tiết [Tên sub-module] screenshots/02-%3Crole%3E-chi-tiet.png
Thành công
[Thông tin hiển thị đầy đủ] → Xem hoàn tất.
Tạo mới
Kết quả: [Mô tả kết quả tạo thành công]
Lưu ý
Trước khi bắt đầu:
- [Điều kiện cụ thể nếu có]
[Mở form tạo mới] ​
[Mô tả thao tác]
Ảnh chưa có: Form tạo mới [Tên sub-module] screenshots/03-%3Crole%3E-tao-moi.png
[Điền thông tin] ​
[Mô tả các trường cần điền, trường bắt buộc]
[Xác nhận] ​
Nhấn [Tên nút xác nhận].
Thành công
Hệ thống hiển thị "[Thông báo thành công]" → Tạo mới hoàn tất.
Chỉnh sửa
Kết quả: [Mô tả kết quả chỉnh sửa thành công]
[Tìm và mở record cần sửa] ​
[Mô tả thao tác]
[Chỉnh sửa thông tin] ​
[Mô tả các trường có thể sửa, ràng buộc nếu có]
[Lưu] ​
Nhấn [Tên nút lưu].
Thành công
Hệ thống hiển thị "[Thông báo thành công]" → Chỉnh sửa hoàn tất.
Xóa
Kết quả: [Mô tả kết quả xóa thành công]
Cảnh báo
[Cảnh báo về tính không thể hoàn tác hoặc điều kiện cần kiểm tra trước khi xóa]
[Tìm record cần xóa] ​
[Mô tả thao tác]
[Xóa và xác nhận] ​
Nhấn [Tên nút xóa] → Xác nhận trong hộp thoại.
Ảnh chưa có: Hộp thoại xác nhận xóa screenshots/04-%3Crole%3E-xoa.png
Thành công
Hệ thống hiển thị "[Thông báo thành công]" → Xóa hoàn tất.
(Nếu tài liệu có nhiều sub-module: nhóm các expandable hành động dưới heading ### [Tên Sub-module].)
III. Lưu ý & Quy tắc nghiệp vụ ​
Lưu ý
Lưu ý quan trọng:
- [Lưu ý 1]
- [Lưu ý 2]
- [Lưu ý 3]
Thông tin
Mẹo sử dụng:
- [Mẹo 1]
- [Mẹo 2]
- [Mẹo 3]
IV. Các Lỗi Thường Gặp & Cách Xử Lý ​
| Lỗi / Tình huống | Nguyên nhân | Cách xử lý |
|---|---|---|
| [Thông báo lỗi hoặc mô tả tình huống] | [Nguyên nhân] | [Cách xử lý] |
| Không tìm thấy dữ liệu | Sai bộ lọc hoặc chưa có dữ liệu | Kiểm tra lại điều kiện tìm kiếm → bấm Reset |
| [Tình huống khác] | [Nguyên nhân] | [Cách xử lý] |
📩 Chưa tự xử lý được? Liên hệ [Kênh hỗ trợ] hoặc tạo ticket tại [Link].