documentation-and-adrs

Create formal ADRs and standardize project documentation.

Updated May 27, 2026
One-click install
npx skills add https://github.com/santanapol/agent-skills --skill documentation-and-adrs-santanapol
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/santanapol/agent-skills/tree/main/.cursor/skills/documentation-and-adrs
Command: npx skills add https://github.com/santanapol/agent-skills --skill documentation-and-adrs-santanapol

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of losing critical context around technical and architectural decisions, which leads to repeated team debates, slow onboarding for new engineers and AI agents, and inconsistent implementation of project standards across the codebase.

Core Features & Use Cases

  • Architectural Decision Records (ADRs): Capture the full context, trade-offs, and rationale behind major technical choices (e.g., selecting a database, authentication strategy) to avoid re-debating old decisions.
  • Inline Code Documentation: Guide teams to write meaningful "why" comments instead of redundant "what" comments, and document known gotchas to prevent common errors for future maintainers and agents.
  • Project Documentation Standards: Provide templates and best practices for READMEs, API docs, and changelogs to ensure consistent, useful documentation across the project. For example, when your team chooses to switch from REST to GraphQL for your public API, use this Skill to create a formal ADR that records all considered trade-offs, the final decision, and its long-term consequences, so future team members and AI agents don't waste time re-evaluating the same choice.

Quick Start

Use the documentation-and-adrs skill to create a formal ADR for your team's recent decision to adopt PostgreSQL as the primary database, including all context, trade-offs, 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 create an Architectural Decision Record to document technical choices?

To create an Architectural Decision Record (ADR), document the full context, considered trade-offs, final decision, and long-term consequences of a technical choice. This preserves project context and prevents new team members or AI agents from re-debating established decisions.

What is the best way to document project context for onboarding new AI agents?

Documenting project context for AI agents requires standardized READMEs, API documentation, and meaningful inline code comments explaining the 'why' behind logic. This ensures agents understand architectural decisions and avoid common errors during codebase interaction.

How do I write meaningful inline code comments that preserve technical context?

Write meaningful inline code comments by focusing on the 'why' a decision was made rather than the 'what' the code does. Documenting known gotchas and architectural rationale prevents common errors for future maintainers and AI agents interacting with the codebase.

Does this approach help maintain standardized API documentation and changelogs?

Yes, this approach provides templates and best practices for maintaining standardized API documentation, READMEs, and changelogs. This ensures consistent, useful documentation is available across the entire project for both human engineers and automated agents.

When do I need a formal ADR for selecting major technical dependencies?

You need a formal ADR when selecting major technical dependencies, designing data models, or defining public APIs. Recording the rationale and trade-offs during these events avoids repeated team debates and ensures consistent implementation of project standards.