When should I use this skill?

Use this skill whenever you need to document a significant technical decision. Activate it with prompts like "create an ADR for our new caching strategy" or "update ADR-005 with new consequences" to maintain a clear and standardized decision log.

How does this skill improve my workflow?

It saves you time by automating tedious tasks like numbering and formatting. By enforcing consistency and guiding you to document context, trade-offs, and alternatives, it improves the clarity and long-term value of your project's architectural history.

What unique capabilities does it provide?

This skill enforces a strict ADR structure, automates file naming conventions, promotes documenting trade-offs, and guides the use of pseudocode instead of implementation-specific code. It also analyzes existing ADRs to match your project's specific style.

What does the ADR Writer skill do?

The ADR Writer skill helps you create and edit Architecture Decision Records (ADRs). It strictly enforces a predefined structure (Context, Decision, Consequences), automates file naming, and ensures your team's technical decisions are documented consistently.

ADR Writer

Name: ADR Writer
Author: yaakaito

byyaakaito

•

学習とドキュメンテーション

Creates and edits Architecture Decision Records (ADRs) following strict, project-specific formatting and content guidelines.

概要

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.

概要

主な機能

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.