Receber por email
← Voltar para o catálogo

create-adr

Create Architecture Decision Records (ADRs) based on MADR template. Use when the user asks to "create an ADR", "document a decision", "write an ADR", or provides decision context that needs to be formalized.

0estrelas
Atualizado há 5 meses

Ver no GitHub ↗ Licença: MIT

Como adicionar

/plugin marketplace add broneq/bdk

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/create-adr-broneq/svg)](https://www.skillteca.com.br/skills/create-adr-broneq)

Skills relacionadas

Ver todas de Documentos →

Alerta por categoria

Receba novas skills de Documentos toda segunda

1 email curto, só com as skills novas de Documentos. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Create ADR

Relies on BDK foundation (STARTUP_INSTRUCTIONS.md) for project context and MCP tool preference.

<!-- INJECT: architecture -->

Generate ADR following MADR format.

Input

$ARGUMENTS

Process

1. Analyze Input

Extract from free-form description:

  • Problem statement and context
  • Considered options
  • Constraints and decision drivers
  • Stated preference or chosen option

2. Ask Targeted Questions

Use AskUserQuestion to fill gaps — only ask what's genuinely unclear.

Always ask:

  • ADR status (proposed/accepted/rejected/deprecated)

Never ask — user adds manually after generation:

  • Decision-makers, consulted, informed (use {TBD} placeholder in frontmatter)

3. Determine Next ADR Number

Scan docs/adr/ for existing ADR files matching pattern NNNN-*.md. Use next sequential number, zero-padded to 4 digits.

4. Generate ADR Document

Write to docs/adr/NNNN-{slugified-title}.md following MADR format:

---
status: {status}
date: {YYYY-MM-DD}
decision-makers: {TBD}
consulted: {TBD}
informed: {TBD}
---

# ADR-NNNN: {Title}

## Context and Problem Statement
{2-3 sentences describing the problem}

## Decision Drivers
- {driver 1}
- {driver 2}

## Considered Options
1. **{Option A}** — {one-line summary}
2. **{Option B}** — {one-line summary}

## Decision Outcome
**Chosen option: {Option}**, because {justification}.

### Consequences
- ✅ {positive consequence}
- ❌ {negative consequence}
- 🟡 {neutral consequence}

### Implementation Requirements
- [ ] {requirement 1}

## Pros and Cons of the Options

### {Option A}
{description}

- ✅ {pro}
- ❌ {con}

### {Option B}
...

## More Information
{additional context, links, follow-up decisions}

Formatting rules:

  • Use ✅ for pros, ❌ for cons, 🟡 for neutral
  • Never use "Good, because" / "Bad, because" — use symbols directly

5. Generate Diagrams (Optional)

Only create diagrams when they add genuine visual value:

  • Architecture options with different component layouts
  • Options with different data flows or system interactions

Skip for trivially simple or abstract decisions.

If creating diagrams:

  • Embed Graphviz diagrams directly in ADR as fenced code blocks ( `dot ), preceded by ### header — compiler uses header as filename
  • After writing ADR file, invoke /bdk:graphviz-docs-compiler passing docs/adr/ as target directory with --mode both to extract .dot files and compile to SVG
  • Compiler rewrites code blocks in-place with ![Description](images/name.svg) references

6. Final Verification

  • Read generated ADR file and verify formatting
  • Show user generated ADR path and summary

Rules

  • Diagrams optional — only generate when they add genuine visual value
  • Don't over-ask — extract maximum info from free-form input before asking
  • No commits — generate files only, user decides when to commit
Compartilhar X LinkedIn