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

Domains - Documentation Guidelines for AI

Domains521 words3 min read
active
  • Giúp AI đọc repo theo mô hình domain-first ở cấp workspace.
  • Khóa rõ thứ tự ưu tiên: domain -> workspace -> surface -> shared -> support.
  1. Đọc docs/Domains/DOM_Docs_Content_Placement_Map.md để biết file mình sắp mở là canonical, support, hay artifact.
  2. Xác định primary_domain.
  3. Xác định workspace:
    • Product Discovery
    • Feature Package
    • UX Design
  4. Mở doc trong docs/Domains/<domain>/<workspace>/** trước.
  5. Nếu có rule dùng chung, mở docs/Shared/**.
  6. Chỉ sau đó mới lùi xuống support docs như docs/context/**, docs/plans/**, hoặc legacy subtree được workspace overview trỏ tới.
  • Product Discovery:
    • dùng khi câu hỏi là decision, state, open question, event, contract, extraction.
    • thường là lớp sync-back khi UX update đã được làm hoặc đã đủ rõ để làm.
  • Feature Package:
    • dùng khi câu hỏi là framing capability, value proposition, business feature, product narrative.
  • UX Design:
    • dùng khi câu hỏi là flow, IA, screen logic, experience structure, content direction.
    • là default first stop khi user đã nêu feature, flow, screen, hoặc update cụ thể.
  • docs/Shared/** chỉ giữ những gì dùng chung toàn hệ:
    • Design System
    • Shared Capabilities
    • Operations
    • Knowledge Base
  • Không đưa narrative chính của DOL English, DOL Academy, DOL Kid vào đây.
  • docs/Shared/Shared Capabilities/Ecosystem Experience/SHR_ECOSYSTEM_UX_00_Overview.md là ecosystem north-star hiện tại.
  • Trong docs/Shared/Shared Capabilities/**, một số folder platform cũ có thể vẫn tồn tại như legacy subtree; coi capability overview là entry canon, còn subtree cũ là supporting reference nếu overview có trỏ tới.
  • Current Supporting Sources trong mỗi workspace overview là body docs của workspace đó hoặc subtree liên quan bên trong home mới, không phải lane tạm ở root.
  • Prompt ngắn vẫn hợp lệ:
    • ENG: ...
    • ACA: ...
    • KID: ...
  • Nếu user không nói workspace, AI phải tự suy ra:
    • discovery
    • feature
    • ux
  • Nếu user đã nêu target UX đủ cụ thể, mặc định ưu tiên UX Design trước rồi sync Product Discovery nhanh nếu cần.
  • Nếu vẫn mơ hồ, mặc định ưu tiên UX Design cho idea flow sản phẩm, trừ khi prompt rõ là discovery-only, decision-only, hoặc capability framing.
  • Không bắt user phải biết tài liệu nằm ở UX Design, Feature Package, hay Product Discovery trước.
  • Không tái tạo cây folder cũ ở root như docs/Product Discovery/**, docs/Feature Package/**, docs/Knowledge base/**, docs/Operations/**, docs/Design System Doc/**, hoặc docs/UX Design/**.
  • Không clone Design System thành 3 bản độc lập theo domain.
  • 2026-03-07: Tạo guideline repo-level cho AI theo trục domain -> workspace -> shared -> legacy.
  • 2026-03-07: Cập nhật guideline sau khi body folders đã được chuyển vào home mới trong docs/Domains/**docs/Shared/**.
  • 2026-03-07: Bỏ phụ thuộc vào root docs/UX Design/ sau khi folder này được retire.