Pular para o conteúdo
Skillpedia
Escrita40 mil · #5077

create-architectural-decision-record

Ajuda seu agente a criar um registro de decisões importantes sobre a arquitetura de um projeto. Isso garante que as decisões sejam documentadas e fáceis de entender.

O que ela faz

Esta ferramenta cria um documento chamado Registro de Decisão Arquitetural (ADR). Ele serve para registrar decisões importantes sobre como um projeto de software deve ser construído, explicando o problema, a solução escolhida e por que outras opções foram descartadas.

Quando usar

  • ✓Ao decidir qual banco de dados usar para um novo projeto.
  • ✓Ao escolher uma nova tecnologia para implementar uma funcionalidade.
  • ✓Ao documentar uma mudança importante na estrutura de um sistema existente.

Exemplo do que pedir para a IA

“Crie um registro de decisão arquitetural para a escolha do banco de dados principal, considerando o contexto de escalabilidade e o custo.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/github/awesome-copilot/blob/main/skills/create-architectural-decision-record/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/github/awesome-copilot/blob/main/skills/create-architectural-decision-record/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

Você fornece informações sobre o problema (contexto), a decisão tomada, as alternativas pensadas e quem está envolvido. A ferramenta organiza tudo isso em um formato padrão, incluindo prós e contras, para que a decisão seja clara e fácil de consultar.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add github/awesome-copilot --skill create-architectural-decision-record

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/create-architectural-decision-record/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Criar Registro de Decisão Arquitetural

Crie um documento de ADR para ${input:DecisionTitle} usando formatação estruturada otimizada para consumo por IA e legibilidade humana.

Entradas

  • Contexto: ${input:Context}
  • Decisão: ${input:Decision}
  • Alternativas: ${input:Alternatives}
  • Partes Interessadas: ${input:Stakeholders}

Validação de Entrada

Se alguma das entradas necessárias não for fornecida ou não puder ser determinada a partir do histórico da conversa, peça ao usuário para fornecer as informações faltantes antes de prosseguir com a geração do ADR.

Requisitos

  • Use linguagem precisa e sem ambiguidade
  • Siga o formato padronizado de ADR com front matter
  • Inclua consequências positivas e negativas
  • Documente alternativas com justificativa de rejeição
  • Estruture para análise por máquina e referência humana
  • Use marcadores codificados (códigos de 3-4 letras + números de 3 dígitos) para seções com múltiplos itens

O ADR deve ser salvo no diretório /docs/adr/ usando a convenção de nomenclatura: adr-NNNN-[title-slug].md, onde NNNN é o próximo número sequencial de 4 dígitos (por exemplo, adr-0001-database-selection.md).

Estrutura de Documentação Necessária

O arquivo de documentação deve seguir o modelo abaixo, garantindo que todas as seções sejam preenchidas adequadamente. O front matter do markdown deve ser estruturado corretamente conforme o exemplo a seguir:

---
title: "ADR-NNNN: [Decision Title]"
status: "Proposed"
date: "YYYY-MM-DD"
authors: "[Stakeholder Names/Roles]"
tags: ["architecture", "decision"]
supersedes: ""
superseded_by: ""
---

# ADR-NNNN: [Decision Title]

## Status

**Proposed** | Accepted | Rejected | Superseded | Deprecated

## Context

[Problem statement, technical constraints, business requirements, and environmental factors requiring this decision.]

## Decision

[Chosen solution with clear rationale for selection.]

## Consequences

### Positive

- **POS-001**: [Beneficial outcomes and advantages]
- **POS-002**: [Performance, maintainability, scalability improvements]
- **POS-003**: [Alignment with architectural principles]

### Negative

- **NEG-001**: [Trade-offs, limitations, drawbacks]
- **NEG-002**: [Technical debt or complexity introduced]
- **NEG-003**: [Risks and future challenges]

## Alternatives Considered

### [Alternative 1 Name]

- **ALT-001**: **Description**: [Brief technical description]
- **ALT-002**: **Rejection Reason**: [Why this option was not selected]

### [Alternative 2 Name]

- **ALT-003**: **Description**: [Brief technical description]
- **ALT-004**: **Rejection Reason**: [Why this option was not selected]

## Implementation Notes

- **IMP-001**: [Key implementation considerations]
- **IMP-002**: [Migration or rollout strategy if applicable]
- **IMP-003**: [Monitoring and success criteria]

## References

- **REF-001**: [Related ADRs]
- **REF-002**: [External documentation]
- **REF-003**: [Standards or frameworks referenced]
Perguntas frequentes

O que é um ADR?

ADR significa 'Architectural Decision Record', um documento que registra decisões importantes sobre a arquitetura de um projeto de software.

Por que usar códigos como POS-001 ou NEG-001?

Esses códigos ajudam a organizar as informações de forma clara e permitem que ferramentas de computador entendam e processem o documento mais facilmente, além de facilitar a referência a pontos específicos.

Onde o documento é salvo?

O documento é salvo em uma pasta chamada `/docs/adr/` com um nome que inclui um número sequencial e um resumo do título da decisão.

Detalhes

Descrição original do autor

Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.

repo: github/awesome-copilot

Popularidade

Estrelas no GitHub
40 mil
Posição no ranking
#5077
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas