Guidelines for writing and maintaining project documentation. TRIGGER when: writing, editing, or reviewing documentation files in docs/. DO NOT TRIGGER when: editing code comments or README files.
Generic skill — This skill is project-agnostic. Do not add project-specific references, paths, or terminology here.
Guidelines for writing and maintaining project documentation.
Use this skill when:
docs/Never duplicate file contents into documentation. Instead, use Sphinx directives to include the real file so docs stay in sync automatically:
```{literalinclude} ../../path/to/real/file.yaml
:language: yaml
```
If a full include is too long, use :lines: or :start-after: /
:end-before: to select a portion.
When documenting directory layouts or file sets that vary, describe the general structure and mention that additional files may exist. Listing every optional file creates maintenance burden and goes stale as the project evolves.
When referencing Claude Code skills (slash commands), use the actual skill
name from .claude/skills/*/SKILL.md. If a skill is renamed or removed,
update all documentation that references it.
If two docs cover the same topic, consolidate into one and link to it from the other. Avoid parallel pages that drift apart over time.
This project follows the Diataxis documentation