JPeetz/agent-skills / skills/documentation-content/documentation-and-adrs
documentation-and-adrs
VerifiedUse this skill when you need to record an architecture decision (ADR) or document the reasoning behind a design choice — when changing public APIs, shipping features that change behavior, or recording context that future engineers (human or agent) will need to understand the codebase. Does NOT replace code comments or inline docstrings; targets strategic documentation and decision capture. Primary keywords: ADR architecture decision record, technical documentation, design rationale, decision log, API documentation, README writing, changelog, documentation-driven development, inline documentation best practices, specification writing. For all major agentic platforms.
| File | Kind | Size |
|---|---|---|
| CHANGELOG.md | markdown | 941 B |
| LICENSE | other | 1.0 KB |
| SKILL.md | skill md | 12.0 KB |
| evals/evals.json | config | 5.9 KB |
| references/adr-template.md | markdown | 2.3 KB |
| references/api-docs-checklist.md | markdown | 2.0 KB |
| references/readme-template.md | markdown | 2.1 KB |
CHANGELOG.md
View on GitHub# Changelog
## [1.0.0] - 2026-09-21
### Added
- Initial release of the documentation-and-adrs skill
- SKILL.md with full: Overview, When to Use, Process (documentation-driven development), ADR lifecycle and templates, documentation layers (README, API docs, inline docs, changelogs), Common Rationalizations table, Red Flags, and Verification checklist
- LICENSE (MIT)
- evals/evals.json with 7 evaluation cases covering: ADR generation, inline documentation quality, README structure, API documentation, anti-rationalization detection, documentation audit, and changelog format
- references/adr-template.md — full ADR template with decision drivers, considered options, mitigations, implementation plan
- references/readme-template.md — README structure with all required sections
- references/api-docs-checklist.md — API documentation completeness checklist
[1.0.0]: https://github.com/JPeetz/agent-skills/compare/initial...v1.0.0Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |