documentation-and-adrs

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

Updated Sep 3, 2024
One-click install
npx skills add https://github.com/eminboydak/duckTerm --skill documentation-and-adrs-eminboydak
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/eminboydak/duckTerm/tree/main/.agents/skills/documentation-and-adrs
Command: npx skills add https://github.com/eminboydak/duckTerm --skill documentation-and-adrs-eminboydak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering decisions lose their context over time, leaving future developers and AI agents guessing why the codebase looks the way it does. This Skill captures the reasoning behind architectural choices, public API changes, and shipped features so that knowledge survives team turnover and time. ## Core Features & Use Cases - Architecture Decision Records (ADRs): Creates numbered ADRs with context, decision, alternatives considered, and consequences, while matching any existing project convention for location, numbering, and format. - Inline and API Documentation: Guides writing comments that explain why rather than what, plus typed docstrings and OpenAPI specs for public interfaces. - READMEs and Changelogs: Provides templates for project READMEs (quick start, commands, architecture) and 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 requirements, rejected alternatives, and consequences so the decision is never re-litigated. ## Quick Start Write an ADR documenting the decision to use Tauri with Svelte for this desktop application, including the alternatives considered.

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?

An ADR documents a significant technical decision with sections for status, date, context, decision, alternatives considered, and consequences. Store it as a numbered Markdown file, for example in docs/decisions/, and never delete old records since they preserve historical context.

When should I write an ADR for a project?

Write an ADR when choosing frameworks or major dependencies, designing data models, selecting API architectures, or making any decision that would be expensive to reverse. A short record prevents re-debating the same decision months later.

What should code comments explain in a codebase?

Comments should explain why the code exists, not restate what it does. Document non-obvious intent, constraints, and known gotchas, and avoid TODO comments, commented-out code, and notes on self-explanatory functions.

Does this Skill follow existing ADR conventions in a repository?

Yes. Before creating an ADR it inspects the repository for existing ADRs, configuration like an .adr-dir file, and established numbering or naming patterns, then matches that convention instead of imposing a default template.

When should I not write documentation?

Skip documentation for self-explanatory code, throwaway prototypes, and comments that merely restate what the code already says. Focus effort on decisions, public APIs, and gotchas where context is not visible in the code itself.