skills.rest
melikhanmutlu
melikhanmutluCOMMUNITY
Explore all skills by this author →
GitHub

architecture-decision-records

Create and manage architecture decision records using MADR templates and adr-tools.

Updated Dec 10, 2024
Search Tags:#architecture#templates#documentation#adr#governance#engineering
One-click install
npx skills add https://github.com/melikhanmutlu/web_ar --skill architecture-decision-records-melikhanmutlu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-decision-records
Source: https://github.com/melikhanmutlu/web_ar/tree/main/skills/architecture-decision-records
Command: npx skills add https://github.com/melikhanmutlu/web_ar --skill architecture-decision-records-melikhanmutlu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture decision records provide a structured approach to documenting critical technology choices, capturing context, options, and rationale, and ensuring traceability across projects.

Core Features & Use Cases

  • ADR templates and lifecycle: standardized formats for capturing decisions, status, and consequences.
  • Documentation governance: central index and cross-referencing of related ADRs, with automation.
  • Collaboration and onboarding: helps teams align on decisions and onboard new engineers.

Quick Start

Create a new ADR using the Madr/MADR template and the adr-tools workflow to generate and link ADRs, updating the index accordingly.

Frequently Asked Questions about architecture-decision-records

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

FAQPage Schema
What is an architecture decision record and when do I need one?▼

An architecture decision record (ADR) captures critical technology choices, context, options, and rationale. You need ADRs to ensure traceability and governance across software architecture projects when documenting major technical decisions and their consequences.

How do I create and manage ADRs using the MADR template?▼

Create an ADR using the MADR template and adr-tools workflow to generate and link records. Update the central ADR index to maintain standardized documentation structure, lifecycle status tracking, and cross-referencing of related decisions across projects.

Does this ADR documentation approach work for team onboarding and governance?▼

ADR documentation supports team onboarding and governance by providing a central index of architectural decisions. New engineers can review captured trade-offs and rationale, ensuring alignment on technology choices and consistent project documentation standards.

What is the best way to document architectural trade-offs and consequences?▼

The best way to document architectural trade-offs is using standardized ADR templates. The MADR format enforces capturing context, options, and consequences, while adr-tools automation ensures consistent structure, traceability, and cross-referencing of related decisions.

How do I maintain an ADR index and cross-reference related architecture decisions?▼

Maintain an ADR index using adr-tools to generate and link architecture decision records. The MADR template workflow updates the central index automatically, ensuring cross-referencing of related decisions and consistent lifecycle governance across projects.

Why use MADR templates instead of unstructured documentation for architecture decisions?▼

MADR templates provide standardized formats for capturing decision status and consequences, unlike unstructured documentation. This enforces consistent structure and traceability, enabling effective governance and cross-referencing of related ADRs across software architecture projects.

Related Skills

Explore More Software Engineering Skills→
flight505flight505
4

architecture-research

Evaluate technology options and document decisions with Architecture Decision Records.

Community
Advanced
kmylpenterkmylpenter

update-planning-docs

Update CHANGELOG, DEVLOG, and ADR project planning documents.

Community
Intermediate
ccfccf

architecture-decision-records

Document architectural decisions with a MADR-style template and lifecycle.

Community
Advanced
angga30angga30

architecture-decision-records

Capture and standardize architectural decisions using MADR, Lightweight ADR, and RFC templates.

Community
Advanced