documentation-and-adrs

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

Updated Jun 23, 2026
One-click install
npx skills add https://github.com/jampissarandev/Expense-Tracker --skill documentation-and-adrs-jampissarandev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/jampissarandev/Expense-Tracker/tree/main/.github/skills/documentation-and-adrs
Command: npx skills add https://github.com/jampissarandev/Expense-Tracker --skill documentation-and-adrs-jampissarandev

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 questions or guess why the codebase looks the way it does. This Skill provides templates and rules for capturing the why behind decisions through ADRs, inline comments, API docs, READMEs, and changelogs. ## Core Features & Use Cases - Architecture Decision Records (ADRs): A complete template with status lifecycle (Proposed → Accepted → Superseded/Deprecated), alternatives analysis, and consequences, stored in docs/decisions/ with sequential numbering. - Inline Documentation Rules: Clear guidance on commenting the why rather than the what, documenting known gotchas, and avoiding TODOs and commented-out code. - API & Project Documentation: Patterns for TSDoc-style function documentation, OpenAPI/Swagger specs, README structure, and changelog maintenance. - Use Case: After choosing PostgreSQL over MongoDB for a new service, use this Skill to write ADR-001 capturing the context, rejected alternatives, 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 context, alternatives considered, and consequences.

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 (ADR)?

Create a Markdown file in docs/decisions/ with sequential numbering, containing Status, Date, Context, Decision, Alternatives Considered, and Consequences sections. Document why each alternative was rejected, not just which option was chosen.

When should I write an ADR for a software project?

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. Trivial or easily reversible choices do not need one.

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, updating the old ADR's status to Superseded.

What is the difference between good and bad code comments?

Good comments explain why code exists, such as non-obvious constraints or design rationale, while bad comments restate what the code already says. Avoid TODO comments for work you should do now and delete commented-out code instead of keeping it.

What should a project README include?

A README should include a one-paragraph project description, quick start steps, a commands table covering dev/test/build/lint, an architecture overview linking to ADRs, and contributing guidelines. This lets new engineers and agents run the project without assistance.