Bỏ qua để đến nội dung
DOL Wiki

Cấu trúc tài liệu chung - Overview (Templates)

CommandTemplates367 words2 min read
active

Purpose

Phần tiêu đề “Purpose”
  • Cung cấp bộ template v2 chuẩn cho UX docs theo mô hình Core + Conditional (Need-based).
  • Giúp team/AI viết nhanh nhưng không dư section, đồng thời giữ tài liệu decision-complete khi cần.
  • Áp dụng theo chính sách Forward-only: chỉ chuẩn hoá doc mới hoặc doc đang được chỉnh sửa.

Elements

Phần tiêu đề “Elements”

Scope

Phần tiêu đề “Scope”
  • Sections bắt buộc phụ thuộc vào doc_role - xem rule-doc-standards.md §2 profile table.
  • Mặc định (page-spec): 6 core sections (Purpose, Experience Narrative, Elements, Logic, UI/Behavior, Change log).
  • Các role khác (feature-master, canonical-map, concept-pack, …) có profile nhẹ hơn.
  • Mọi section mở rộng chỉ được thêm khi trigger checklist thỏa điều kiện.
Phần tiêu đề “Recommended Use In The Team Loop”
  • Pha Codex -> logic core: bắt đầu từ CMD_Templates_Logic.md.
  • Pha Antigravity -> UI exploration / sync-back: bắt đầu từ CMD_Templates_Screen_Flow.md.
  • Nếu có thay đổi phát sinh từ UI exploration, phân loại rõ:
    • visual-only
    • interaction-refinement
    • logic-affecting
  • Chỉ logic-affecting mới bắt buộc cập nhật lại canon trong EduDoc trước khi coi là quyết định chính thức.

Technical Notes

Phần tiêu đề “Technical Notes”
  • H1 contract: # <VN Title> (<EN Context>).
  • Change log contract: YYYY-MM-DD: <impact summary> và giữ tối đa 3-5 mục gần nhất.
  • Frontmatter cho doc mới/chạm chỉnh sửa: title, slug (khuyến nghị thêm updated, owner, status).
  • Tham chiếu rule chính: .agent/rules/rule-doc-standards.md.

Note

Phần tiêu đề “Note”
  • Không tạo section placeholder (TBD, sẽ cập nhật, section rỗng).
  • Nếu section mở rộng không cần thiết, bỏ hẳn thay vì để trống.

References

Phần tiêu đề “References”