optimize agent-docs
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
Use this structure for Markdown files inside `agent-docs/` when the document's main job is to track a maintained set of entries: media plans, registries, migration queues, or cleanup lists.
|
||||
|
||||
## Recommended Shape
|
||||
## Minimum Required Shape
|
||||
|
||||
```md
|
||||
# <Document Title>
|
||||
@@ -27,6 +27,10 @@ Use this structure for Markdown files inside `agent-docs/` when the document's m
|
||||
- <when repeated notes should become policy in a rule doc>
|
||||
- <when this inventory should split or link to a narrower rule doc>
|
||||
|
||||
## Classification Authority
|
||||
|
||||
- <who or what decides the classification scheme or status changes>
|
||||
|
||||
## Entries
|
||||
|
||||
### <Grouping Heading>
|
||||
@@ -49,6 +53,22 @@ Notes:
|
||||
- <questions for keeping the inventory current and unambiguous>
|
||||
```
|
||||
|
||||
## Required Sections
|
||||
|
||||
- `# <Document Title>`
|
||||
- opening statement
|
||||
- `## Applies To`
|
||||
- `## Maintenance Rules`
|
||||
- `## Reclassification Rules`
|
||||
- `## Classification Authority`
|
||||
- `## Entries`
|
||||
- `## Maintenance Checklist`
|
||||
|
||||
## Conditionally Required Sections
|
||||
|
||||
- `## Does Not Apply To` when the inventory would otherwise be confused with a rule doc, public docs, or another registry
|
||||
- grouping headings under `## Entries` when they materially improve scanning or maintenance ownership
|
||||
|
||||
## Notes
|
||||
|
||||
- Prefer an inventory template when the document is mostly a maintained list rather than a rules essay.
|
||||
@@ -58,6 +78,7 @@ Notes:
|
||||
- Use grouping headings only when they materially improve navigation.
|
||||
- Separate durable maintenance rules from the entries themselves.
|
||||
- If the governing policy becomes large, move it to a rule doc and link to it from the inventory.
|
||||
- Add `Reclassification Rules` when entry state changes or repeated review decisions would otherwise stay implicit.
|
||||
- Treat `Classification Authority` as required. If status or grouping rules have no authority anchor, the inventory is not stable enough to maintain.
|
||||
- Treat `Reclassification Rules` as required. Repeated state transitions should not stay implicit in review comments or maintenance folklore.
|
||||
- Write for maintainers and make update decisions explicit.
|
||||
- If the document references repository files, write repository-relative paths in backticks, not Markdown links or machine-local absolute filesystem paths.
|
||||
|
||||
Reference in New Issue
Block a user