documentation-and-adrs

Document architectural decisions and design rationale in ADR records.

9|Updated Dec 20, 2025

Search Tags:#architecture #templates #documentation #adr #rationale #decision-records

Ready to run

npx skills add https://github.com/christopher-buss/flux --skill documentation-and-adrs-christopher-buss

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/christopher-buss/flux/tree/main/.agents/skills/documentation-and-adrs
Command: npx skills add https://github.com/christopher-buss/flux --skill documentation-and-adrs-christopher-buss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document decisions and rationale to preserve context for future engineers and agents working in the codebase.

Core Features & Use Cases

ADR tracking and architecture decision records that capture context, constraints, and trade-offs.
Templates and inline documentation to guide future contributors and agents.
Case studies of decisions such as framework or API design choices, with rationale and alternatives.

Quick Start

Create and maintain ADRs for major decisions to keep a clear historical record.

Frequently Asked Questions about documentation-and-adrs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What is an architecture decision record and when should I create one?▼

An architecture decision record (ADR) documents context, constraints, and trade-offs for major project choices. Create ADRs when selecting frameworks, data models, or major dependencies to preserve context for future engineers.

How do I document architectural decisions to preserve project rationale?▼

Document architectural decisions by applying ADRs that capture context, constraints, and alternatives. Maintain a living history across the project using ADR templates and inline documentation standards to ensure consistent knowledge sharing.

What's the best way to track framework and API design choices in a codebase?▼

The best way to track framework and API design choices is maintaining ADRs as case studies. Store inline documentation standards and ADR templates to capture design rationale, alternatives, and project-specific gotchas for future contributors.

Can I use ADR templates to maintain a living history across my project?▼

Yes, ADR templates support maintaining a living history across your project. Apply templates to document major decisions like data models and dependencies, capturing rationale and alternatives to preserve context for future engineers and agents.

When should I not use architecture decision records for documentation?▼

Architecture decision records should not be used for minor implementation details. Reserve ADRs for major decisions involving framework choices, data models, or major dependencies where capturing context, constraints, and trade-offs provides value.

Do I need inline documentation standards alongside architecture decision records?▼

Yes, inline documentation standards complement architecture decision records by guiding future contributors and agents. Store inline gotchas and documentation standards alongside ADRs to ensure consistent knowledge sharing across the project.