Why is documenting the 'why' important in code?

Code explains 'how' a feature works, but the 'why'—the trade-offs, rejected alternatives, and constraints—is often lost, making future maintenance and refactoring difficult.

Where does the Explain skill save its documentation?

The skill defaults to a /decisions directory, but it can be configured via .inclusion-config.md to use other paths like /docs/adr or /docs/decisions.

How does the skill know what to document?

The skill can analyze recent uncommitted changes, specific file paths you provide, or respond to specific questions about why one approach was chosen over another.

What is an Architecture Decision Record (ADR)?

An ADR is a short text file that captures an important architectural decision, including the context in which it was made, the options considered, and the resulting consequences.

Implementation Decision Records

Name: Implementation Decision Records
Author: hereinthehive

byhereinthehive

학습 및 문서화

Capture implementation rationale by generating structured markdown decision records for long-term project maintainability.

소개

This skill automates the creation of Architecture Decision Records (ADRs) to capture the rationale behind complex code changes, architectural shifts, and library choices. By documenting the 'why' instead of just the 'what,' it preserves critical project context, simplifies onboarding for new developers, and ensures that trade-offs are explicitly understood and tracked throughout the project lifecycle. It integrates with existing project structures and configurations to ensure documentation lives alongside the code it describes.

주요 기능

Configurable storage locations with support for existing decisions/ or docs/ directories
Automated creation of structured Markdown decision records (ADRs)
In-depth analysis of architectural trade-offs and alternative solutions considered
0 GitHub stars
Standardized naming conventions using incrementing sequence numbers (NNNN-kebab-case.md)
Context-aware research of existing codebase patterns and constraints

사용 사례

Explaining the reasoning behind non-obvious performance optimizations or algorithms
Documenting the selection of a new state management library over existing options
Recording architectural pivot points to prevent future regressions and clarify project history

소개

주요 기능

Configurable storage locations with support for existing decisions/ or docs/ directories
Automated creation of structured Markdown decision records (ADRs)
In-depth analysis of architectural trade-offs and alternative solutions considered
0 GitHub stars
Standardized naming conventions using incrementing sequence numbers (NNNN-kebab-case.md)
Context-aware research of existing codebase patterns and constraints

사용 사례

Explaining the reasoning behind non-obvious performance optimizations or algorithms
Documenting the selection of a new state management library over existing options
Recording architectural pivot points to prevent future regressions and clarify project history