Files
bluecraft/skills/bluecraft-agentic-docs/references/refactor-checklist.md
Ge Song 3bf898afab docs(bluecraft-agentic-docs): refine documentation structure terminology and patterns
Update skill definition and templates to use "references" instead of "routing"
throughout, clarify the root AGENTS.md as the entry document for agent-docs, and
add explicit linking patterns guidance. Improve template wording to emphasize
directional, explicit references and minimal reference depth.

- Rename and expand linking patterns reference
- Update SKILL.md trigger conditions and core rules
- Refine child doc template compatibility note
- Update refactor checklist to focus on reference depth
- Simplify root AGENTS.md template structure
2026-04-20 12:48:31 +08:00

20 lines
1.2 KiB
Markdown

# Refactor Checklist
Use this checklist after changing the root `AGENTS.md` or any file in `agent-docs/`.
- Does each covered document own one clear topic?
- Does each filename clearly express the document's purpose?
- Does each opening explain purpose, trigger, and that the document must be followed in scope?
- Is the `AGENTS.md` at the root of the current Git working tree still the root entry document?
- Does every active `agent-docs/` file have an explicit path from the root?
- Does each child doc use the right shape for its job: rule doc versus inventory doc?
- Did you remove stale references, filenames, and replaced paths?
- Did you remove any orphan instruction docs created by the refactor?
- Did you avoid duplicating the same rule across multiple active docs?
- Did you avoid mixing long entry inventories into rule docs when a separate inventory would be clearer?
- Is the default path basis still the root of the current Git working tree unless explicitly overridden?
- Are repository-wide constraints still in the root file?
- Are topic-specific constraints still in child docs?
- Did you keep reference depth minimal?
- If the repository has a validation command, did you run it?