Ge Song
98d5818b32
Add explicit guidance to use repository-relative paths in backticks when referencing files from `AGENTS.md` and `agent-docs/`. Prevent machine-local absolute paths and Markdown links in these docs so routing instructions stay portable and consistent.
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
# Rule `agent-docs/` Template
|
|
|
|
Use this structure for Markdown files inside `agent-docs/` when the document's main job is to govern behavior: rules, policy, constraints, decision criteria, or workflow guidance.
|
|
|
|
## Recommended Shape
|
|
|
|
```md
|
|
# <Document Title>
|
|
|
|
<Opening statement: what this doc governs, when it applies, and that it must be followed in scope.>
|
|
|
|
## Applies To
|
|
|
|
- <specific task or document types>
|
|
|
|
## Does Not Apply To
|
|
|
|
- <out-of-scope task or document types>
|
|
|
|
## <Rule Section>
|
|
|
|
- <instructions>
|
|
|
|
## Checklist
|
|
|
|
- <validation questions>
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Make the scope explicit.
|
|
- Keep the document responsible for one topic.
|
|
- Use semantic filenames and headings.
|
|
- If the document references repository files, write repository-relative paths in backticks, not Markdown links or machine-local absolute filesystem paths.
|
|
- State the user or maintainer decision directly: what to do, what to avoid, and how to choose.
|
|
- Prefer linking to inventories, examples, or narrower child docs instead of embedding long registries inline.
|