documentation-and-adrs

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

Updated Jul 10, 2026
One-click install
npx skills add https://github.com/CodeCrafterAdi2006/Ink-and-Code --skill documentation-and-adrs-codecrafteradi2006
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/CodeCrafterAdi2006/Ink-and-Code/tree/main/Skills/documentation-and-adrs
Command: npx skills add https://github.com/CodeCrafterAdi2006/Ink-and-Code --skill documentation-and-adrs-codecrafteradi2006

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering decisions lose their context over time, leaving future developers and AI agents unable to understand why code was built a certain way, which leads to repeated debates, reverted decisions, and undocumented public APIs. ## Core Features & Use Cases - Architecture Decision Records (ADRs): Provides a numbered ADR template with status lifecycle, alternatives analysis, and consequences sections stored in docs/decisions/. - Inline and API Documentation: Defines when to comment (the why, not the what), JSDoc/TSDoc patterns for public functions, and OpenAPI structure for REST endpoints. - README and Changelog Standards: Supplies templates covering quick start, command tables, architecture overviews, and semantic changelog entries. - 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 contributors 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 numbered markdown file in docs/decisions/ with sections for Status, Date, Context, Decision, Alternatives Considered, and Consequences. Document why each alternative was rejected, not just which option won, so future readers understand the constraints.

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 expensive to reverse. Skip ADRs for trivial or easily reversible choices.

What should code comments explain?

Comments should explain why code exists, not what it does. Document non-obvious intent, constraints, and known gotchas. Avoid comments that restate the code, TODO markers for work you should do now, and commented-out code that git history already preserves.

Should old ADRs be deleted when decisions change?

No, old ADRs capture historical context and should be kept. When a decision changes, write a new ADR that references and supersedes the old one, updating the old record's status to Superseded.

What are the limitations of documentation-only guidance?

This Skill provides templates and conventions but does not enforce them automatically. Teams must still adopt the discipline of writing ADRs at decision time, since retroactive documentation often loses the original context and trade-off reasoning.