ADR Writer

关于

Standardize the documentation of significant architectural choices with a structured approach. This skill generates and updates Architecture Decision Records (ADRs) that adhere to a precise format, including specific sections like Context, Decision, and Consequences, as well as strict file naming conventions. It guides the user to provide clear, implementation-ready decisions using pseudocode while avoiding project-specific code. Use this skill whenever you need to formally document a design decision, ensuring every ADR is consistent, clear, and easy for the team to understand.

主要功能

• Guides the use of pseudocode to illustrate concepts instead of implementation-specific code.
• Promotes clear documentation of decision context, trade-offs, and considered alternatives.
• Enforces a strict, predefined ADR structure (Context, Decision, Consequences).
• Follows project-specific conventions by referencing existing ADRs for style.
• 3 GitHub stars
• Automates ADR numbering and file naming conventions.

使用场景

• Updating an existing ADR to reflect new information or a revised decision.
• Formally documenting a new architectural decision for a project.
• Recording the justification and trade-offs for choosing a specific technology or pattern.