doc-architecture-adr

Generate Architecture Decision Records in the MADR format.

3|1|Updated Apr 18, 2021

Search Tags:#architecture #decision making #documentation #adr #technical decisions #madr

Ready to run

npx skills add https://github.com/nashgao/mqtt-client --skill doc-architecture-adr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-architecture-adr
Source: https://github.com/nashgao/mqtt-client/tree/main/.claude/skills/doc/doc-architecture-adr
Command: npx skills add https://github.com/nashgao/mqtt-client --skill doc-architecture-adr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of documenting critical technical decisions, ensuring clarity, consistency, and a traceable history of architectural choices.

Core Features & Use Cases

Structured Decision Records: Generates Architecture Decision Records (ADRs) using the MADR format.
Comprehensive Documentation: Guides users through context gathering, option analysis, and decision documentation.
Use Case: When deciding on a new database technology, use this Skill to create an ADR that outlines the problem, evaluates options like SQL vs. NoSQL, and documents the final decision and its consequences.

Quick Start

Use the doc-architecture-adr skill to create a new Architecture Decision Record for the topic 'Implementing a new caching layer'.

Frequently Asked Questions about doc-architecture-adr

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) documents significant technical decisions to ensure clarity and traceable history. You need an ADR when making architectural choices, such as selecting a new database technology, to record the context, options, and consequences systematically.

How do I document technical decisions using the MADR format?▼

To document technical decisions using the MADR format, generate a structured Architecture Decision Record that guides you through gathering context, analyzing options, and recording the final decision along with its consequences to ensure adherence to documentation standards.

What's the best way to structure context and options for technical decisions?▼

The best way to structure context and options for technical decisions is by using a systematic approach like the MADR format, which guides you through defining the problem, evaluating alternatives such as SQL versus NoSQL, and documenting the resulting consequences.

Can I use this to evaluate SQL versus NoSQL for a new database technology?▼

Yes, you can use this to evaluate options like SQL versus NoSQL for a new database technology. It generates an Architecture Decision Record that outlines the problem, analyzes the alternatives, and documents the final technical decision and its consequences.

Does this approach require any specific dependencies or environments?▼

No, this approach requires no specific dependencies or environments to document technical decisions. It operates independently to generate structured Architecture Decision Records using the MADR format, facilitating a systematic approach to decision-making without prerequisite setups.