Documentation & ADRs

•
58k
•

Records architectural decisions and engineering context to ensure maintainable, transparent codebases for both humans and AI agents.

The Documentation and ADRs skill enables AI coding agents to capture the 'why' behind technical choices, ensuring that the reasoning, constraints, and trade-offs of a project are never lost. By implementing standardized Architecture Decision Records (ADRs), it provides a historical log of significant changes—such as framework selections or database schemas—while guiding the creation of structured READMEs and intent-focused inline comments. This skill is essential for maintaining long-term project health, as it provides future developers and AI agents with the necessary context to understand existing architectural patterns and avoid repeating past mistakes.

主な機能

01Agent-specific context management via CLAUDE.md and rules files
0257,850 GitHub stars
03Comprehensive README templates for project onboarding and architecture overviews
04Standardized ADR creation with lifecycle tracking (Proposed, Accepted, Superseded)
05Type-safe API documentation for TypeScript and OpenAPI/Swagger standards
06Intent-focused inline documentation guidelines to explain non-obvious logic

ユースケース

01Providing context for AI agents to prevent invalid code suggestions
02Documenting public API changes and breaking architectural shifts
03Recording the rationale for choosing specific tech stacks or libraries