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

DOL Education Documentation Knowledge Index

KnowledgeIndex441 words2 min read
activebyDOL Education Documentation
  • Điểm vào ngắn gọn cho người và AI trước khi chỉnh repo này.
  • Repo này dùng cấu trúc domain-first; nguồn chuẩn nằm ở docs/Domains/**docs/Shared/**, không nằm trong file index này.
  • README.md: overview repo, entry docs, local workflow, và map các guideline chính.
  • docs/README.md: taxonomy chuẩn, placement rules, authoring defaults, và boundary giữa Domains / Shared / support lanes.
  • GUIDELINES_MASTER.md: full contract cho contributor và AI khi cần mở rộng scope.
  • CONTRIBUTING.md: process và guardrail cộng tác ở cấp repo.
  • .agent/rules/rule-doc-standards.md: chuẩn shape cho doc mới/chỉnh sửa, gồm exception cho router/overview docs.
  • ai-memory/MEMORY.md: index cho lesson, incident, và pattern bền vững của repo.
  • docs/Domains/**: source of truth theo domain và workspace. Với DOL English, khi cần current UX logic của một feature, ưu tiên đọc docs/Domains/DOL English/UX Design/** trước; Product DiscoveryFeature Package là lane supporting.
  • docs/Shared/**: source of truth cho capability, design system, operations, và knowledge dùng chung nhiều domain.
  • docs/Command/**: principle, template, terminology, và command/reference ở cấp repo.
  • docs/context/**: AI routing layer; không phải canon human-facing.
  • docs/plans/**: execution plans và working plans.
  • docs/tmp/**: artifact lane; không dùng làm source of truth.
  • npm run context:guard: hard gate cho AI routing coverage và readability.
  • npm run context:benchmark: benchmark các case routing chính.
  • npm run context:stale: phát hiện stale context card.
  • npm run context:lint: inventory rộng; coverage sẽ thấp nếu tính cả docs/tmp/** và một số run records trong operations.
  • Không rename folder canonical chỉ để đổi thứ tự hiển thị; dùng config order hoặc authoring workspace order.
  • Khi một surface có nhiều overview docs, mỗi file phải khai báo rõ doc role như workspace entry, surface entry, global baseline, domain delta, canonical map, hoặc bridge.
  • Khi shared logic/capability trở thành canon, repoint domain docs sang path shared đang sống thay vì để lại legacy paths hoặc duplicate spec.
  • Mọi thay đổi trong docs/context/** phải qua context:guardcontext:benchmark trước khi kết luận xong việc.
  • Phần meta index docs được gom tại docs/Meta/.
  • Các path docs/product-specs/, docs/adr/, docs/runbooks/, docs/generated/, docs/quality/ vẫn được giữ như reserved entrypoints cho knowledge workflow.
  • README trong các folder đó chỉ là compatibility stub; map thật nằm ở docs/Meta/README.md.
  • Các root meta/stub này được cấu hình để không nổi lên như area publish chính của wiki.