Documentation and ADRs teaches an agent to document the why behind decisions. It provides an ADR template with status, context, alternatives and consequences, and tells the agent to match any existing ADR convention before applying its defaults.
The skill also covers inline comments, API documentation, README structure, changelogs, documentation for agents, a prose review pass and a git-based method for deciding whether a doc is stale.
What You Get
- An ADR template and lifecycle
- Guidance for inline comments, API docs, READMEs and changelogs
- A drift-detection shell snippet that uses git history
- A prose review procedure and a verification checklist
Common Use Cases
- Writing an ADR for a significant technical choice
- Documenting a public API change
- Checking whether docs are out of date
- Setting up README and rules files for a project
What Makes It Unique
The skill includes a drift check that decides staleness from commit order and refuses to call a doc current when the order is unknown. It also protects change logs by requiring dated appended entries and a prose review step that preserves qualifiers.
Under The Hood
The skill is a single SKILL.md of instructions and templates. Its drift snippet runs git log and git merge-base on the repository, which is read-only. The agent also writes documentation files such as ADRs, READMEs and changelogs in the project.