document-decision

Create standardized Architecture Decision Records using the arc42 template.

9|2|Updated Nov 29, 2024
One-click install
npx skills add https://github.com/bbvch-ai/aihub-core --skill document-decision-bbvch-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-decision
Source: https://github.com/bbvch-ai/aihub-core/tree/main/.claude/skills/document-decision
Command: npx skills add https://github.com/bbvch-ai/aihub-core --skill document-decision-bbvch-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of losing critical context for significant technical choices, ensuring teams can track the rationale behind major architectural changes, dependency additions, and pattern shifts without relying on scattered meeting notes or informal chat history.

Core Features & Use Cases

  • Standardized ADR Creation: Generates Architecture Decision Records that strictly follow the project's required arc42 template structure, including mandatory Context, Decision Drivers, Decision, and Consequences sections.
  • Conflict Prevention: Automatically scans existing ADRs to avoid duplicate entries and flags decisions that supersede prior records to maintain a clean decision log.
  • Use Case: When your team decides to replace the current observability tool with Langfuse, use this Skill to create a formal, consistent record of the choice that future team members can reference to understand the trade-offs and rationale.

Quick Start

Use the document-decision skill to create a new ADR documenting the decision to adopt ValKey as our primary caching layer.

Frequently Asked Questions about document-decision

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

FAQPage Schema
How do I document technical decisions using Architecture Decision Records?

Architecture Decision Records document technical decisions by capturing context, decision drivers, and consequences. You create standardized ADR files using the arc42 template structure to formalize architectural choices like framework adoptions or dependency additions.

What is an ADR and when should I use one in software architecture?

An ADR is a formal record documenting the rationale behind a significant technical choice. You should create an ADR when making major dependency additions, adopting new frameworks, or changing fundamental software patterns to ensure the rationale is preserved.

Can I check if a new ADR conflicts with existing decision logs?

Yes, you can check for conflicting ADRs. The process involves scanning existing decision logs to prevent duplicate entries and flagging new records that supersede prior architectural decisions, maintaining a clean and searchable documentation history.

What is the best way to maintain consistent architecture decision documentation?

The best way to maintain consistent documentation is enforcing template compliance and project-specific naming conventions. Standardizing ADR creation with the arc42 structure ensures all technical decisions remain searchable and uniformly formatted.

Does the arc42 template work for logging software architecture changes?

Yes, the arc42 template works for logging architecture changes. It structures decision documentation with mandatory Context, Decision Drivers, Decision, and Consequences sections to capture the full rationale behind pattern shifts.