documentation-and-adrs

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

Updated Sep 15, 2026
One-click install
npx skills add https://github.com/Qiuyi-Hong/addyosmani-skills --skill documentation-and-adrs-qiuyi-hong
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/Qiuyi-Hong/addyosmani-skills/tree/main/skills/documentation-and-adrs
Command: npx skills add https://github.com/Qiuyi-Hong/addyosmani-skills --skill documentation-and-adrs-qiuyi-hong

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 documentation. ## 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 API docs with parameters, return values, and thrown errors, including OpenAPI specs for REST endpoints. - READMEs and Changelogs: Provides templates for project READMEs covering quick start, commands, and architecture, plus structured changelogs for shipped features. - Use Case: After choosing PostgreSQL over MongoDB for a new service, use this Skill to write an ADR documenting the alternatives considered and consequences so future engineers never re-litigate the decision. ## Quick Start Ask the agent to write an ADR documenting the architectural decision you just made, including the alternatives you considered and why they were rejected.

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 your project's existing ADR convention if one exists.

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 old one, following the lifecycle from proposed to accepted to superseded.

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, stale TODOs, or commented-out code that version control already preserves.

What should a project README include?

A README should include a one-paragraph project description, quick start steps, a commands table, an architecture overview linking to ADRs, and contributing guidelines covering coding standards and the PR process.