skills.rest
tejovanthn
tejovanthnCOMMUNITY
Explore all skills by this author →
Website𝕏@ibakasuraGitHub

architecture-decision-records

Create standardized Architecture Decision Records with YAML frontmatter and structured sections.

1|Updated Aug 7, 2024
Search Tags:#templates#documentation#governance#ADR#coding-standards#software-engineering#architecture-decision-records
One-click install
npx skills add https://github.com/tejovanthn/rasikalife --skill architecture-decision-records-tejovanthn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-decision-records
Source: https://github.com/tejovanthn/rasikalife/tree/main/.opencode/skill/architecture-decision-records
Command: npx skills add https://github.com/tejovanthn/rasikalife --skill architecture-decision-records-tejovanthn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture Decision Records (ADRs) provide a structured way to capture significant technical decisions, their context, rationale, and trade-offs so teams can learn from past choices and maintain architectural alignment over time.

ADRs enable a consistent approach to documenting decisions, making it easier to onboard new engineers, review past rationale during refactors, and track how architecture evolves.

Core Features & Use Cases

  • Standardized ADR templates that enforce a consistent file structure (adr-NNN-title.md) and frontmatter with name and description.
  • Traceability & rationale: captures the problem context, proposed alternatives, trade-offs, decisions, and outcomes for auditability.
  • Guidance for governance: supports team adoption with naming conventions, directory layout, and review workflows.

Quick Start

  1. Identify the architectural decision to capture and determine the next ADR number.
  2. Create a new file under docs/architecture-decisions/ with the name adr-NNN-title.md following the ADR template.
  3. Populate the frontmatter with name and description and fill out Problem, Alternatives, Decision, Implementation, and Future Considerations sections.

Frequently Asked Questions about architecture-decision-records

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

FAQPage Schema
How do I document architecture decisions with rationale and context?▼

Document architecture decisions by creating Architecture Decision Records (ADRs) that capture problem context, proposed alternatives, trade-offs, decisions, and outcomes. Standardized ADR templates enforce a consistent file structure and frontmatter for auditability and team alignment.

What is the standard file naming convention for architecture decision records?▼

The standard naming convention for architecture decision records uses the format adr-NNN-title.md. Files are organized under a docs/architecture-decisions/ directory to ensure consistent ADR discovery and governance across engineering teams.

How do I structure an ADR template for software engineering projects?▼

Structure an ADR template by populating YAML frontmatter with a name and description, followed by Problem, Alternatives, Decision, Implementation, and Future Considerations sections. This captures critical architectural choices with full traceability.

What metadata is required in the frontmatter of an architecture decision record?▼

The required metadata in an architecture decision record's frontmatter includes at least a name and description. This mandatory YAML frontmatter ensures critical architectural choices are captured with baseline context for governance and review workflows.

Can I use architecture decision records for governance and onboarding in small teams?▼

Architecture decision records support team adoption for governance and onboarding in teams of any size. They provide structured documentation of past rationale, making it easier to review decisions during refactors and track how architecture evolves over time.

What optional directories can I include when setting up ADR documentation?▼

Optional directories that support ADR development and discovery include scripts/, references/, and assets/. These directories supplement the standardized adr-NNN-title.md files and YAML frontmatter to enhance architecture decision governance workflows.

Related Skills

Explore More Software Engineering Skills→
racciolyraccioly

documentation-templates

Generates README, API docs, code comment, changelog, and ADR templates with defined sections.

Community
Intermediate
leonardoteodorooleonardoteodoroo

architecture-decision-records

Organize Architecture Decision Records with templates, lifecycle tracking, and indexing.

Community
Intermediate
VidyaBodepudiVidyaBodepudi
2

documentation-and-adrs

Manage documentation standards and Architecture Decision Records for software projects.

Community
Intermediate
senior-sigansenior-sigan

architecture-decision-records

Capture architectural decisions as structured ADR documents with context and rationale.

Community
Advanced