skills.rest
ghalactic
ghalacticOFFICIAL
Explore all skills by this author →
WebsiteGitHub

adr-skill

Create, maintain, and review Architecture Decision Records in a repository.

2|Updated Aug 24, 2024
Search Tags:#architecture#documentation#adr#engineering#best-practices#decision-making
One-click install
npx skills add https://github.com/ghalactic/provision-github-tokens --skill adr-skill-ghalactic
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr-skill
Source: https://github.com/ghalactic/provision-github-tokens/tree/main/.agents/skills/adr-skill
Command: npx skills add https://github.com/ghalactic/provision-github-tokens --skill adr-skill-ghalactic

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This skill solves the problem of undocumented architectural changes and tribal knowledge loss by providing a structured, repeatable process for proposing, recording, and maintaining Architecture Decision Records (ADRs).

Core Features & Use Cases

  • Socratic Interviewing: Guides users through a structured interview to capture the intent, constraints, and tradeoffs of a decision before drafting.
  • Automated Lifecycle Management: Provides scripts to generate new ADRs from templates and update statuses (e.g., accepted, deprecated, superseded) in-place.
  • Review & Consultation: Includes a comprehensive checklist for peer review and guidelines for consulting existing ADRs to ensure architectural consistency.

Quick Start

Use the adr-skill to propose a new architectural decision by initiating the interview process to capture the context and intent of your proposed change.

Frequently Asked Questions about adr-skill

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

FAQPage Schema
How do I document architectural decisions to prevent tribal knowledge loss?▼

Architecture Decision Records (ADRs) document architectural changes by providing a structured process for proposing, recording, and maintaining decisions within a software repository. This prevents tribal knowledge loss by capturing intent, constraints, and tradeoffs.

What is the best way to create a new Architecture Decision Record?▼

Creating an Architecture Decision Record is best handled by initiating a Socratic interview to capture context and intent, followed by generating the ADR from a standardized template using automated management scripts.

Do I need Node.js to manage Architecture Decision Records?▼

Yes, Node.js is required to execute the management scripts for Architecture Decision Records. These scripts automate ADR generation from templates and update decision statuses like accepted, deprecated, or superseded in-place.

How do I track the status of architectural decisions in a software repository?▼

Tracking the status of architectural decisions is supported through automated lifecycle management scripts that update statuses such as accepted, deprecated, or superseded directly in-place within your software repository.

How does peer review work for architectural documentation?▼

Peer review for architectural documentation works by utilizing a comprehensive checklist to evaluate proposed decisions and consulting existing Architecture Decision Records to ensure architectural consistency across the software repository.

When should I not use Architecture Decision Records?▼

Architecture Decision Records should not be used for non-architectural changes. They are designed specifically for capturing architectural intent, constraints, and tradeoffs, so applying them to trivial modifications adds unnecessary documentation overhead.

Related Skills

Explore More Software Engineering Skills→
fritzprixfritzprix
8

system-setup

Install and verify MCP runtime dependencies across Windows, Linux, and macOS.

Community
Intermediate
VictorHueniVictorHueni

arch-adr

Automate creation, review, and maintenance of Architecture Decision Records using MADR 4.x conventions.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
tankpkgtankpkg
1

@tank/idd

Manage Intent-Driven Development from intent definition to code-intent drift detection.

Official
Advanced