diff --git a/AGENTS.md b/AGENTS.md index f5dd539..4d5724e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -673,6 +673,36 @@ docs_v1.0/M4_workspace/YYYY-MM-DD__test_report.md (測試報告) 詳細規範見 `docs_v1.0/M4_workspace/M4_NOTIFICATION_PROTOCOL.md`。 +## Document Compliance Checklist + +Before creating any `REFERENCE/*.md` file, verify all items below. + +### P0 — Mandatory (7 items) + +| # | Check | Rule | +|---|-------|------| +| 1 | YAML frontmatter | `title`, `version`, `date`, `author`, `status` present | +| 2 | Version history | Table at bottom of file tracking changes | +| 3 | Top info table | scope, status, applicable to, etc. | +| 4 | PascalCase filename | e.g. `DetectorRegistry.md`, not `detector_registry.md` | +| 5 | `_` separator | Within filenames use `_`, never spaces or other chars | +| 6 | English content | Entire file in English | +| 7 | REFERENCE/ path | File must reside under `docs_v1.0/REFERENCE/` | + +### P1 — Suggested (3 items) + +| # | Check | Note | +|---|-------|------| +| 1 | Cross-references | Link to related REFERENCE docs | +| 2 | Glossary terms | Define non-obvious terms inline or link glossary | +| 3 | Diagrams | Include Mermaid/ASCII diagram for complex topics | + +### Exception + +`M4_workspace/` files are exempt from this checklist (free-format reply documents). + +--- + ## Delivery Procedure 完整交付程序(M4_workspace → M5 → Release → Deploy → Public)見: