Skip to content

Checklist: Generate User Guide ​

Orientation ​

  • [ ] Audience / role xác định rõ ở đầu tài liệu.
  • [ ] Ngôn ngữ user/business — không dùng thuật ngữ kỹ thuật nếu không giải thích.
  • [ ] Cấu trúc theo user workflow order, không theo feature list hay cấu trúc kỹ thuật.

Per Feature ​

  • [ ] Mục đích (tính năng làm gì).
  • [ ] Điều kiện tiên quyết (quyền, dữ liệu cần có).
  • [ ] Các bước thực hiện: step-by-step rõ ràng.
  • [ ] Kết quả mong đợi: hệ thống phản hồi gì.
  • [ ] Lưu ý / lỗi thường gặp / edge case quan trọng với user.

Screenshots ​

  • [ ] Mỗi hành động chính có ≥1 ảnh trong step: ![Caption](screenshots/...) đứng một mình, dòng trống trên/dưới, caption viết vào alt text.
  • [ ] KHÔNG dán dòng *italic* ngay dưới ảnh (gộp thành 1 đoạn → ảnh hiển thị BÉ khi import); KHÔNG dùng thẻ <figure>/<img>/<figcaption>.
  • [ ] Đường dẫn ảnh tương đối (screenshots/NN-<role>-<mo-ta>.png) và file tồn tại thật.
  • [ ] Ảnh chụp ở viewport desktop 1920×1080 (rộng ~1920px, layout giống desktop thật — không bị thu gọn/sidebar phình do viewport hẹp).
  • [ ] Không dính artifact hover/tooltip (tooltip sidebar, popover tạm) trong ảnh.
  • [ ] Ảnh capture từ môi trường UAT/staging bằng tài khoản test; không Submit/Delete trên dữ liệu thật khi chụp.
  • [ ] Screenshots missing → marked <!-- TODO --> tại chỗ + hint info hiển thị nêu lý do (comment HTML không render trên GitBook, người đọc phải thấy được lý do) + ghi vào pending-screenshots.md kèm lý do và cách xử lý (không im lặng bỏ qua).
  • [ ] Ảnh chính thức nằm trong ba/projects/<project>/docs/user-guide/screenshots/, không để sót trong .playwright-mcp/.

Quality &ZeroWidthSpace;

  • [ ] Section II: mỗi hành động = {% details summary="[Tên hành động]" %} bọc TRỌN (Kết quả + hint warning/danger nếu có + {% stepper %} + hint success), đóng {% enddetails %} sau success. KHÔNG dùng heading ### N. cho hành động.
  • [ ] Tag cân bằng: mỗi {% details %} có {% enddetails %}, mỗi {% stepper %} có {% endstepper %}.
  • [ ] Bảng mô tả cột/trường đặt NGAY TRONG step tương ứng, có chừa dòng trống trước/sau bảng.
  • [ ] Role / permission differences covered nếu relevant.
  • [ ] FS chưa chốt → section đó marked "Draft – Pending Confirmation".
  • [ ] Tên màn hình / field nhất quán với FS.
  • [ ] Correct folder / version.
  • [ ] Ảnh dùng ![Mô tả](screenshots/...) với caption trong alt text, KHÔNG dán dòng *italic* dưới ảnh; không sót thẻ <figure>/<img>/<figcaption>.
  • [ ] (chỉ khi BA yêu cầu zip) Mỗi file md có file zip cùng tên, cùng folder, chứa md + đủ ảnh được tham chiếu.
  • [ ] (chỉ khi có zip) Zip nén bằng .NET (dấu / trong path nội bộ), KHÔNG dùng Compress-Archive (dấu \ → ảnh trắng khi import GitBook).