agentleFS
RodrigoAnciaesRodrigoAnciaes/golem-sdd/.claude/skills/adr/SKILL.md

adr

Skill0 starsChanged 3 days agoMITView on GitHub

Registra uma decisão técnica em docs/adr/NNN-titulo.md com contexto, opções consideradas, decisão, consequências e gatilho de revisão. Use quando o usuário disser "registrar decisão", "escrever um ADR", "documentar por que escolhemos X", "vale a pena usar A ou B?" ou invocar /adr.

97 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use fdr, runbook and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • thiagofgfSkill

    fdr

    Use when creating, changing, reviewing, retiring, auditing, or backfilling implemented user-visible feature behavior, permissions, feature-specific rationale, tradeoffs, or relationships to architectural decisions.

    Also in 3 projects that use this

  • AnthropicSkill

    runbook

    Create or update an operational runbook for a recurring task or procedure. Use when documenting a task that on-call or ops needs to run repeatably, turning tribal knowledge into exact step-by-step commands, adding troubleshooting and rollback steps to an existing procedure, or writing escalation paths for when things go wrong.

    Also in 5 projects that use this

  • drewdrewthisSkill

    sweep

    Search for similar patterns, anti-patterns, or issues elsewhere in the codebase after a fix or feature. Use after implementing a fix to catch the same bug in other places, or proactively to audit for a known pattern.

    Also in 4 projects that use this

  • vndeeSkill

    product-spec

    Use when starting a new feature, product, or project — before any architecture or code, to define what to build and why

    Also in 3 projects that use this

  • OpenAISkill

    threat-model

    Use when Codex is already in the threat-modeling phase of a security scan, the user explicitly invokes $threat-model, or the user explicitly asks to create, update, or persist a repository threat model. Do not use as the primary trigger for full PR, commit, branch, patch, or repository scans.

    Also in 6 projects that use this

  • montymiSkill

    tech-spec

    Parse and review Technical Specification documents for completeness, consistency, and implementation readiness

    Also in 3 projects that use this

The file

Files
SKILL.md

ADR: registro de decisão de arquitetura

Lê: specs/tech-stack.md, specs/roadmap.md e os ADR já existentes em docs/adr/. Escreve: só docs/adr/NNN-titulo.md. Não mexe em código nem em spec sem pedir. Decide: se a decisão merece ADR (tem alternativa real e consequência duradoura) e qual opção recomendar. Para e propõe se a escolha exigir dependência fora da tech-stack.

Quando isto se aplica

Escreva um ADR quando a decisão for cara de reverter, atravessar várias fases ou voltar a ser questionada em seis meses. Exemplos: escolha de banco, estratégia de autenticação, adoção de fila, formato de contrato entre serviços.

Decisão pequena e local não vira ADR: ela vive na seção "Decisões" do requirements.md da fase. Na dúvida, pergunte: "alguém vai perguntar 'por que isso é assim?' daqui a um ano?"

Fluxo

1. Numerar

ls docs/adr/[0-9]*.md 2>/dev/null | tail -3

Próximo número sequencial, com zero à esquerda: docs/adr/007-fila-de-lembretes.md. O docs/adr/modelo.md, se existir, é a forma a copiar, e não entra na conta.

2. Levantar as opções de verdade

Um ADR com uma opção só é justificativa, não decisão. Traga no mínimo duas alternativas reais, cada uma com o que ganha, o que perde e o custo de reverter. Se o usuário já escolheu, o seu trabalho é registrar honestamente o que foi descartado, inclusive o que a alternativa tinha de bom.

Fato técnico que pesa na escolha (limite de uma API, versão instalada, comportamento medido) vem com a fonte: arquivo:linha, documentação com versão, ou a saída do comando.

3. Escrever

Seções: status, data, decisores, contexto, opções consideradas, decisão, consequências (positivas, dívida aceita, impacto no roadmap e na constituição) e gatilho de revisão: a condição objetiva que faz revisitar a decisão. O modelo está em docs/adr/modelo.md (ou em templates/adr.md do kit).

O contexto descreve forças, não preferências: requisito, limite técnico, prazo, restrição externa. A decisão do usuário entra com as palavras dele e a data.

4. Propagar

  • Mudou a stack? Atualize specs/tech-stack.md e cite o ADR lá
  • Mudou o plano? Ajuste specs/roadmap.md
  • Afeta a fase em curso? Referencie o ADR no requirements.md dela

Restrições

  • ADR aceito não se edita: crie um novo com status "substitui ADR NNN" e marque o antigo
  • Sem gatilho de revisão, o ADR vira dogma: sempre escreva a condição de revisitar
  • Não registre decisão que o usuário ainda não tomou; marque como "proposta"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.