Where does this skill store the ADRs?

The skill is designed to populate and manage records within a DECISIONS.md file located in your project's root directory.

Why is documenting consequences important?

Documenting consequences ensures that the team understands the trade-offs—such as technical debt or performance impacts—incurred by a specific architectural choice.

Does this skill help with team alignment?

Yes, by creating a standardized and shared record of decisions, it ensures all team members are aligned on the current architectural direction and the reasons behind it.

What is an Architectural Decision Record (ADR)?

An ADR is a short text file that captures a significant architectural decision, including the context in which it was made and the consequences it has for the project's future.

Can I use this skill for non-technical decisions?

While optimized for technical architecture, the structured format can be used for any project-level decision where context and rationale are valuable.

Architectural Decision Records (ADR) Writer

Name: Architectural Decision Records (ADR) Writer
Author: CheekyCodexConjurer

byCheekyCodexConjurer

학습 및 문서화

Generates comprehensive Architectural Decision Records to document technical choices, context, and long-term consequences.

소개

The write_adr skill automates the process of capturing critical technical decisions within your codebase using the industry-standard ADR pattern. It ensures that the rationale behind your architecture is preserved for future developers, stakeholders, and audits. By guiding users through the documentation of context, alternatives, and trade-offs, it maintains a centralized history in DECISIONS.md, effectively reducing tribal knowledge and making the evolution of a project's architecture transparent and searchable.

주요 기능

Comparative analysis of architectural alternatives
Structured capture of context, decisions, and consequences
Standardized documentation for compliance and audit trails
Automated ADR template generation in DECISIONS.md
Seamless cross-linking with existing project documentation
0 GitHub stars

사용 사례

Creating an immutable log of technical trade-offs for future refactoring reference
Capturing the rationale for specific design patterns to aid in team onboarding
Documenting the transition to a new database or framework within a quantitative research environment

소개

주요 기능

Comparative analysis of architectural alternatives
Structured capture of context, decisions, and consequences
Standardized documentation for compliance and audit trails
Automated ADR template generation in DECISIONS.md
Seamless cross-linking with existing project documentation
0 GitHub stars

사용 사례

Creating an immutable log of technical trade-offs for future refactoring reference
Capturing the rationale for specific design patterns to aid in team onboarding
Documenting the transition to a new database or framework within a quantitative research environment