When does this skill suggest creating an ADR?

It suggests an ADR when it detects significant changes such as introducing new abstractions, changing security approaches, or adding major infrastructure components.

How do I actually create the ADR?

When the skill identifies an ADR-worthy change, it will provide a command reference, such as '/adr:create', to help you generate the record quickly.

Can I use this for minor bug fixes?

No, the skill specifically ignores routine tasks like bug fixes, minor refactoring, and style changes to avoid unnecessary documentation overhead.

What is an Architectural Decision Record (ADR)?

An ADR is a short text file that captures a specific architectural decision, including the context, the decision itself, and the consequences it has on the project.

Does it interrupt my coding process?

No, the skill is designed to suggest documentation gently and only after the significant work has been completed.

ADR Suggestion Tool

Name: ADR Suggestion Tool
Author: dariuszparys

bydariuszparys

학습 및 문서화

Suggests documenting significant architectural decisions as ADRs to capture technical context and reasoning.

소개

The ADR Suggestion Skill helps developers maintain a high-quality documentation trail by identifying when significant architectural changes occur in a project. It monitors for events such as framework migrations, the introduction of new design patterns, or major refactors, and prompts the user to record the decision-making process. By capturing the 'why' behind complex technical choices, this skill ensures that future maintainers understand the trade-offs and constraints involved in the system's evolution.

주요 기능

Identifies significant framework or dependency additions
Supports infrastructure decision tracking for databases and queues
0 GitHub stars
Detects high-impact architectural shifts and pattern changes
Prompts for documentation after major API or interface breaking changes
Integrates with ADR creation commands to streamline the documentation process

사용 사례

Recording trade-offs when selecting a specific ORM or authentication library
Capturing the context behind major database schema migrations or caching strategies
Documenting the rationale for switching from a monolithic to a microservices architecture

소개

주요 기능

Identifies significant framework or dependency additions
Supports infrastructure decision tracking for databases and queues
0 GitHub stars
Detects high-impact architectural shifts and pattern changes
Prompts for documentation after major API or interface breaking changes
Integrates with ADR creation commands to streamline the documentation process

사용 사례

Recording trade-offs when selecting a specific ORM or authentication library
Capturing the context behind major database schema migrations or caching strategies
Documenting the rationale for switching from a monolithic to a microservices architecture