optimize agent-docs
This commit is contained in:
@@ -2,13 +2,17 @@
|
||||
|
||||
Use this checklist for read-only audits of `AGENTS.md` and `agent-docs/`.
|
||||
|
||||
- Did you classify each finding with the shared severity model?
|
||||
- Is the root `AGENTS.md` still the clear entrypoint?
|
||||
- Can a maintainer tell which document to read first for each common task?
|
||||
- Does any document act like a secondary router without enough reason?
|
||||
- Does each rule appear to have one authoritative home?
|
||||
- Does any inventory document contain policy language that should live in a rule doc?
|
||||
- Does any general-purpose agent-doc mix in project-specific business rules, product instructions, or end-user documentation?
|
||||
- Are authority-dependent rules missing source-of-truth anchors?
|
||||
- Are classification-heavy inventories missing classification authority anchors?
|
||||
- Do key workflow docs state their edge cases and failure modes clearly enough that an agent would not have to infer them?
|
||||
- Would typical user phrasing likely route to the correct skill and document path?
|
||||
- Are there residual cycles or cross-links that materially increase adherence cost?
|
||||
- Which findings are observed facts, and which are inferences about adherence risk?
|
||||
- If there are no concrete findings, what residual risks remain?
|
||||
|
||||
Reference in New Issue
Block a user