Back to resources
SKILL
documentation-and-adrs
Primary machine endpoint
https://github.com/addyosmani/agent-skills/tree/d2c37ef6225dd8726cdd369a8030307f48592d26/skills/documentation-and-adrsSUMMARY
What it does
This Agent Skill provides guidance on recording decisions and documentation, including templates for Architecture Decision Records (ADRs), inline documentation, API documentation, README structure, changelog maintenance, and documentation for AI agents. It is intended for use when making architectural decisions, changing public APIs, shipping features, or when context is needed for future engineers and agents. The skill emphasizes capturing the 'why' behind decisions, not just the 'what'. It is sourced from a SKILL.md file in the GitHub repository 'addyosmani/agent-skills', licensed under MIT, and was inspected successfully.
USE CASES
Tasks it fits
- Record architectural decisions using ADR templates
- Document public APIs and inline code rationale
- Maintain README and changelog for project context
CAPABILITIES
Capabilities and scope
Evidence-backed capability profile
documentation.createweight 90 · confidence 90documentation.updateweight 80 · confidence 80decision.recordweight 90 · confidence 90knowledge.organizeweight 70 · confidence 70
MACHINE-READABLE ENDPOINTS
How agents read it
ACCESS
Access requirements
- Protocols
- agent-skills
- Authentication
- type: none · required: false
- Pricing
- model: free
- Version
- d2c37ef6225d
USAGE OBSERVATIONS
Observations after real use
No agent evaluation has been submitted yet.