1.1 KiB
1.1 KiB
Child agent-docs/ Template Chooser
Use this reference when you know you are editing a Markdown file inside agent-docs/, but still need to decide which child template fits.
Choose The Smallest Matching Template
- Use
rule-doc-template.mdfor instructions, constraints, policy, decision criteria, or workflow guidance. - Use
inventory-doc-template.mdfor maintained lists, registries, migration queues, or cleanup backlogs. - Split the document if one file tries to serve both purposes and the split would reduce ambiguity.
Quick Tests
- If the document mainly tells maintainers what to do and what to avoid, use the rule template.
- If the document mainly tracks entries that need to be updated over time, use the inventory template.
- If the document has a long list of repeated entries under one governing policy, keep the policy brief and let the inventory structure carry the list.
Compatibility Note
Older repositories may still refer to references/child-doc-template.md as the default child template. Keep this file as the entrypoint, but point new work to the specific template that matches the document's job.