sk Skill · addyosmani
documentation-and-adrs
Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
Open on skills.sh ↗read 2026-09-17
- installs 8w
- 20,329
- 30-day movement
- starts with the next reading
- Related entries
- 6
- Connections
- 0
yamltypescriptmarkdownJavaScript
A SKILL.md that guides an AI coding agent through documenting decisions: writing architecture decision records, inline comments, API docs, READMEs, and changelogs. It includes an ADR template and lifecycle rules, plus checklists and common pitfalls.
Reach for it when you want the agent to record the reasoning behind design choices so future engineers and agents can understand the codebase.
Use it to
- Write an ADR for a significant architectural decision
- Document a new or changed public API
- Update the README and changelog after shipping a feature
- Record context that future agents will need
- Audit a repo against the documentation checklist
For Developers and agents maintaining documented codebases
- Host repository
- addyosmani/agent-skills
- Installs, lifetime
- 34k
- Installs, 8 weeks
- 20k
- Host stars
- 96k
- Host language
- JavaScript
topicsdocumentationadrarchitecture-decisionsapi-docsreadmechangelog