Stats
Actions
Tags
From business-docs
Analisa código implementado (.NET + Angular) e gera documentação de regras de negócio em docs/business/. Use quando o usuário mencionar "documentar regras de negócio", "gerar docs de negócio", "business docs", "documentar domínio", "docs/business", "atualizar documentação de negócio", "documentar lógica de negócio" ou pedir para documentar uma área do sistema. NÃO use para especificação funcional (use spec-functional) nem para plano de execução (use plan-execution).
How this skill is triggered — by the user, by Claude, or both
Slash command
/business-docs:business-docsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Analisa código-fonte implementado e documenta regras de negócio em `docs/business/`, uma área por vez,
Analisa código-fonte implementado e documenta regras de negócio em docs/business/, uma área por vez,
usando tasks atômicas (menos de 1 hora cada).
Antes de executar qualquer passo, leia:
references/template-business-rule.md — estrutura padrão de cada arquivo geradoreferences/areas.md — mapeamento de áreas para arquivos destino e código-fonteLeia references/areas.md e verifique se os caminhos de código listados existem no projeto atual.
Se os caminhos não baterem com o projeto:
**/Domain/Entities/, **/Application/Services/, **/Application/Validators/
e **/src/app/**/ para descobrir a estrutura realreferences/areas.md para este projeto antes de gerar a documentação?"areas.md com os caminhos corretos antes de continuarSe os caminhos existirem: siga normalmente a partir do Passo 1.
Liste todos os arquivos em docs/business/ (Glob: docs/business/**/*.md).
Para cada arquivo encontrado, leia e extraia:
Se a pasta não existir, ela será criada no Passo 3 ao escrever o primeiro arquivo.
Para cada área sem cobertura ou desatualizada (conforme references/areas.md), analise os arquivos correspondentes:
| Camada | O que procurar |
|---|---|
Domain/Entities/ | Invariantes, construtores com validação, métodos de domínio, Result Pattern |
Domain/ValueObjects/ | Regras de formato e imutabilidade |
Application/Commands/ e Application/Queries/ | Regras orquestradas, validações cross-entity |
Application/Validators/ | Validações de entrada com FluentValidation |
Infrastructure/Repositories/ | Constraints de dados, queries com filtros de negócio |
Para cada regra encontrada extraia: trigger, condição, ação e localização (arquivo:linha).
| Camada | O que procurar |
|---|---|
src/app/**/services/ | Lógica de negócio no cliente, chamadas HTTP com parâmetros de regra |
src/app/**/guards/ | Regras de acesso a rotas (autorização, autenticação) |
src/app/**/validators/ | Validações de formulário com regra de negócio embutida |
src/app/**/store/ | Estado derivado de regras (seletores, reducers com condições) |
Documente regras Angular apenas quando expressarem lógica de negócio, não lógica de apresentação.
Use TaskCreate para criar uma task por arquivo de documentação a gerar ou atualizar.
Formato do título: [business-docs] Documentar {área}: docs/business/{arquivo}.md
A descrição de cada task deve incluir:
Se uma área tiver mais de 8 regras, divida em duas tasks com sufixos distintos (ex:
fila-pontuacao.mdefila-entrada-saida.md).
Execute na ordem de prioridade definida em references/areas.md. Para cada task:
in_progressdocs/business/ (se houver) para não duplicar regrasreferences/template-business-rule.mdcompletedRegras de escrita:
Ao concluir todas as tasks, exiba:
## Documentação gerada
| Arquivo | Status | Regras documentadas |
|---------|--------|---------------------|
| docs/business/fila.md | criado | RN-001 a RN-005 |
Total: X arquivos, Y regras documentadas
Exemplo 1: Documentação inicial completa Usuário diz: "gera a documentação de regras de negócio do projeto" Ações:
areas.md — caminhos batem com o projetodocs/business/ vaziadocs/business/Exemplo 2: Atualização incremental Usuário diz: "atualiza a documentação de negócio da fila" Ações:
docs/business/fila.md com RN-001 a RN-005FilaService.csfila.md atualizado com RN-006 adicionada
Resultado: arquivo atualizado sem sobrescrever regras existentesExemplo 3: Área específica Usuário diz: "documenta as regras de apresentação de projetos" Ações:
areas.mddocs/business/apresentacoes.mdApresentacao.cs e componente Angular correspondentedocs/business/apresentacoes.md criado com regras de backend e frontendCaminhos de código não encontrados
Execute Glob amplo (**/Entities/*.cs, **/services/*.ts) para descobrir a estrutura real.
Atualize references/areas.md antes de continuar.
Regra já existe com numeração diferente
Mantenha a numeração mais antiga. Adicione (também conhecida como RN-XX) no cabeçalho da regra.
Código não encontrado para uma regra
Documente com status: pendente-implementacao e anote que foi identificada apenas em testes ou comentários.
Área muito grande para uma task Divida pelo critério natural do domínio: operações de escrita vs leitura, ou por sub-entidade relacionada.
Arquivo existente incompleto Faça merge: preserve seções existentes, adicione apenas o que falta. Nunca sobrescreva conteúdo já validado.
Regra Angular vs regra de backend
Se a mesma regra existe em ambas as camadas, documente uma única vez com dois campos Implementação:
**Implementação:**
- Backend: `Application/Services/FilaService.cs` linha 42
- Frontend: `src/app/fila/services/fila.service.ts` linha 18
Provides UI/UX resources: 50+ styles, color palettes, font pairings, guidelines, charts for web/mobile across React, Next.js, Vue, Svelte, Tailwind, React Native, Flutter. Aids planning, building, reviewing interfaces.
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
npx claudepluginhub brunocesharp/claude --plugin business-docs