DOL Education Documentation Knowledge Index
KnowledgeIndex441 words2 min read
Purpose
Phần tiêu đề “Purpose”- Đ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/**vàdocs/Shared/**, không nằm trong file index này.
Start Here
Phần tiêu đề “Start Here”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ữaDomains/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.
Canonical Areas
Phần tiêu đề “Canonical Areas”docs/Domains/**: source of truth theo domain và workspace. VớiDOL English, khi cầncurrent UX logiccủa một feature, ưu tiên đọcdocs/Domains/DOL English/UX Design/**trước;Product DiscoveryvàFeature Packagelà 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.
Quality Gates
Phần tiêu đề “Quality Gates”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.
Repo-specific Guardrails
Phần tiêu đề “Repo-specific Guardrails”- 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 rolenhưworkspace entry,surface entry,global baseline,domain delta,canonical map, hoặcbridge. - 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 quacontext:guardvàcontext:benchmarktrước khi kết luận xong việc.
Reserved Meta Sections
Phần tiêu đề “Reserved Meta Sections”- Phần
meta index docsđược gom tạidocs/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.