documentation-and-adrs

Writes architecture decision records, API documentation, READMEs, and changelogs for software projects.

2|Updated Jul 11, 2026
One-click install
npx skills add https://github.com/MoofonLi/dev-ready --skill documentation-and-adrs-moofonli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/MoofonLi/dev-ready/tree/main/src/dev_ready/templates/claude/skills/documentation-and-adrs
Command: npx skills add https://github.com/MoofonLi/dev-ready --skill documentation-and-adrs-moofonli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering decisions and their rationale are often lost, forcing future developers and AI agents to re-debate settled choices or guess why code was written a certain way. This Skill captures the context, constraints, and trade-offs behind decisions in durable written form. ## Core Features & Use Cases - Architecture Decision Records (ADRs): Creates sequentially numbered ADRs with status, context, decision, alternatives considered, and consequences, while matching any existing project convention for location, numbering, and headings. - Inline and API Documentation: Guides writing comments that explain why rather than what, plus typed docstrings and OpenAPI specs for public APIs. - Project Documentation: Provides templates for READMEs, changelogs, and agent-facing context files like CLAUDE.md. - Use Case: After choosing PostgreSQL over MongoDB for a new service, use this Skill to write an ADR documenting the requirements, rejected alternatives, and consequences so future contributors understand the rationale. ## Quick Start Ask your agent to write an ADR documenting the architectural decision you just made, following the conventions already present in the repository.

Frequently Asked Questions about documentation-and-adrs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an architecture decision record?

Create a Markdown file with sections for status, date, context, decision, alternatives considered, and consequences. Store ADRs in docs/decisions/ with sequential numbering, or match the existing convention already used in your repository.

When should I write an ADR?

Write an ADR when choosing frameworks or major dependencies, designing data models, selecting authentication strategies, deciding API architecture, or making any decision that would be expensive to reverse.

Should old ADRs be deleted when a decision changes?

No, old ADRs should never be deleted because they capture historical context. When a decision changes, write a new ADR that references and supersedes the previous one, following the lifecycle of proposed, accepted, then superseded or deprecated.

What code comments are worth writing?

Comment the why, not the what. Explain non-obvious intent, constraints, and known gotchas, but avoid comments that restate self-explanatory code, leftover TODOs for work you should do now, and commented-out code that git history already preserves.

How does documentation help AI coding agents?

Agents read CLAUDE.md rules files, specs, and ADRs to follow project conventions and understand why past decisions were made, which prevents them from re-deciding settled questions or falling into documented traps.