CommunityEscrita e Ediçãogithub.com

mdesoeuv/claude_skills

Escreve um Registro de Decisão de Arquitetura (ADR) para uma escolha técnica não trivial. Use quando o usuário disser 'devemos usar X ou Y', 'documente por que escolhemos...', 'escreva um ADR', ou quando uma mudança introduzir um novo serviço, banco de dados, fornecedor, padrão ou convenção transversal que futuros engenheiros questionarão.

O que é claude_skills?

Essa skill capacita um assistente de IA a redigir um **Registro de Decisão de Arquitetura (ADR)** – um documento conciso que captura o contexto, as opções consideradas, a decisão tomada e suas consequências para uma escolha técnica importante. Ela é útil para equipes de engenharia que precisam documentar decisões arquiteturais de forma consistente, evitando que questões resolvidas sejam reabertas sem conhecimento do histórico. A skill suporta qualquer plataforma que aceite instruções markdown e é acionada quando o usuário menciona dúvidas sobre alternativas técnicas ou mudanças que introduzam novos componentes. Baseia-se em um template padronizado e orientações de redação que garantem clareza, honestidade sobre opções descartadas e consequências negativas, mantendo o documento em até duas páginas. Quando um argumento é fornecido, ele é usado como título do ADR e para derivar o nome do arquivo.

Funciona com✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mdesoeuv/claude_skills/tree/HEAD/skills/adr

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

Registro de Decisão de Arquitetura

Um ADR existe para que, daqui a dezoito meses, ninguém reabra uma questão já resolvida sem saber por que ela foi resolvida, e para que, quando o contexto mudar, a decisão possa ser revisitada deliberadamente.

Onde

docs/adr/NNNN-titulo-curto.md, numerado sequencialmente. Verifique o diretório para o próximo número e o template da casa; siga-o se existir um.

Template

# NNNN. <Título na forma da decisão: "Usar Aurora PostgreSQL para o serviço de pedidos">

Data: YYYY-MM-DD
Status: Proposto | Aceito | Substituído por NNNN | Depreciado
Decisores: <nomes ou time>

## Contexto
<Quais forças estão em jogo: requisitos, restrições, dor atual, prazos, conformidade,
habilidades do time, envelope de custos. Dois a quatro parágrafos. Fatos, não opiniões.>

## Decisão
<Uma ou duas frases, no presente: "Nós vamos …">

## Opções consideradas
### Opção A: <nome>
Prós / Contras / Custo aproximado / Carga operacional
### Opção B: <nome>
…

## Consequências
<O que fica mais fácil, o que fica mais difícil, o que agora precisamos fazer (migrações,
treinamento, novos runbooks), o que estamos aceitando explicitamente como risco.>

## Acompanhamentos
- [ ] <tarefas concretas com responsáveis, se conhecidos>

Orientações de redação

  • Escreva o contexto para que um novato concorde que o problema é real antes de ler a decisão.
  • Compare opções nos mesmos eixos: custo, carga operacional, dependência, familiaridade do time, tempo para entrega, segurança/conformidade. Coloque números onde você os tiver (estimativa de custo mensal, RTO/RPO, throughput).
  • Seja honesto sobre os pontos fortes das opções perdedoras. Um ADR que distorce alternativas será desacreditado.
  • As consequências incluem as negativas. "Agora temos dois bancos de dados para fazer backup" cabe ali.
  • Mantenha abaixo de duas páginas. Link para spikes, benchmarks e tickets em vez de incluí-los inline.
  • Ao substituir, atualize o status do ADR antigo e faça links em ambos os sentidos.

Quando $ARGUMENTS é fornecido

Use como título; derive o nome do arquivo a partir dele.

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

Habilidades Relacionadas