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

0•

学习与文档

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.

主要功能

01Configurable storage locations with support for existing decisions/ or docs/ directories

02Automated creation of structured Markdown decision records (ADRs)

03In-depth analysis of architectural trade-offs and alternative solutions considered

040 GitHub stars

05Standardized naming conventions using incrementing sequence numbers (NNNN-kebab-case.md)

06Context-aware research of existing codebase patterns and constraints

使用场景

01Explaining the reasoning behind non-obvious performance optimizations or algorithms

02Documenting the selection of a new state management library over existing options

03Recording architectural pivot points to prevent future regressions and clarify project history

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hereinthehive/gotrino-inclusion explain

For use in Claude.ai and ChatGPT

Download Skill