otimização do agent para docuemntação

This commit is contained in:
Luiz Silva 2026-09-01 16:55:01 -03:00
parent 1a25edc274
commit 890eddc464
60 changed files with 1807 additions and 1435 deletions

View file

@ -1,9 +1,9 @@
---
name: documentar-decisao-tecnica
scope: global
updatedAt: "2026-06-01"
updatedAt: "2026-09-01"
description: >
Guia operacional para registrar decisões técnicas e arquiteturais como ADRs (Architecture Decision Records).
Guia operacional para registrar decisões técnicas e arquiteturais como ADRs (Architecture Decision Records) na Wiki de Desenvolvimento (../../wiki/dev/<modulo>/adrs/).
---
# Skill: Documentar Decisão Técnica (ADR)
@ -17,23 +17,23 @@ O objetivo é garantir que **nenhuma decisão fique apenas na cabeça** ou perdi
## Quando usar
- Nova dependência adicionada ao monorepo
- Mudança de padrão arquitetural (ex: de REST para GraphQL)
- Escolha de ferramenta ou lib entre alternativas
- Decisão de breaking change
- Migração de tecnologia
- Mudança de padrão arquitetural (ex: de REST para GraphQL, uso de BullMQ, schemas Zod)
- Escolha de ferramenta ou biblioteca entre alternativas
- Decisão de breaking change de contrato
- Migração de tecnologia ou banco de dados
- Mudança de estratégia de deploy ou CI/CD
- Qualquer decisão que alguém pode questionar daqui 3 meses
- Qualquer decisão técnica relevante para o time ou para a IA
---
## PASSO 1 — Criar o Diretório de ADRs (se não existir)
## PASSO 1 — Localizar o Diretório de ADRs
Convenção de diretório: `../../wiki/dev/<modulo>/adrs/` (na Wiki de Desenvolvimento) ou `.agent/DOCUMENTACAO/arquitetura/`.
```bash
mkdir -p .docs/adrs
mkdir -p ../../wiki/dev/<modulo>/adrs
```
Convenção de diretório: `.docs/adrs/` na raiz do monorepo.
---
## PASSO 2 — Criar o Arquivo ADR
@ -110,10 +110,10 @@ Após criar o ADR, avaliar se a decisão deve gerar:
| A decisão... | Ação |
|-------------|------|
| Cria uma **restrição** permanente (ex: "nunca usar lib X") | Criar/atualizar uma **Rule** em `.agent/local/rules/` |
| Define um **processo** repetível (ex: "para migrar, faça X, Y, Z") | Criar/atualizar um **Workflow** em `.agent/local/workflows/` |
| Refina um **padrão operacional** (ex: "queries agora usam pool separado") | Atualizar a **Skill** correspondente em `.agent/local/skills/` |
| Não gera artefato adicional | Apenas o ADR é suficiente |
| Cria uma **restrição** permanente (ex: "nunca usar lib X") | Criar/atualizar uma **Rule** em `.agent/rules/` |
| Define um **processo** repetível (ex: "para migrar, faça X, Y, Z") | Criar/atualizar um **Workflow** em `.agent/workflows/` |
| Refina um **padrão operacional** (ex: "queries agora usam pool separado") | Atualizar a **Skill** correspondente em `.agent/skills/` |
| Registra histórico de ação da IA | Gravar na memória em `<base_projeto>/memorias-ia/` |
---
@ -152,10 +152,14 @@ Antes de considerar completo:
- [ ] As consequências (positivas e negativas) estão claras?
- [ ] Os pacotes impactados estão listados?
- [ ] O status está definido (proposto/aceito)?
- [ ] A decisão gerou rules/workflows/skills quando aplicável?
- [ ] O ADR foi salvo em `../../wiki/dev/<modulo>/adrs/` ou `.agent/DOCUMENTACAO/arquitetura/`?
- [ ] A decisão foi registrada na memória em `<base_projeto>/memorias-ia/`?
- [ ] Alguém de fora do contexto entenderia este ADR?
---
## Referências
- Workflow: `global/workflows/aprimorar-IA` (seção de classificação de artefatos)
- Workflow: `global/workflows/otimizar-codigos`
- Rule: `rules/ddd-documentacao-primeiro.md`
- Workflow: `global/workflows/aprimora-ia.md`
- Wiki de Desenvolvimento: `../../wiki/dev/<modulo>/adrs/`