melhoria de ia
This commit is contained in:
parent
a3cbd154f5
commit
b188f28ad4
20 changed files with 1060 additions and 61 deletions
|
|
@ -38,18 +38,23 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
|
||||
## Responsabilidades
|
||||
|
||||
1. Criar e manter arquivos `.regras-negocio.md` para módulos com lógica complexa
|
||||
2. Escrever JSDoc em funções e serviços compartilhados
|
||||
3. Criar guias de ajuda para usuários finais (módulo de ajuda contextual)
|
||||
4. Manter o `README` e documentação do projeto atualizada
|
||||
5. Documentar APIs internas (contratos de rotas, parâmetros, retornos)
|
||||
1. **Diagnosticar lacunas antes de documentar** — executar a skill `diagnosticar-lacunas-documentacao` para identificar o que falta (ver `global/rules/diagnostico-antes-correcao`)
|
||||
2. Criar e manter arquivos `.regras-negocio.md` para módulos com lógica complexa
|
||||
3. Escrever JSDoc em funções e serviços compartilhados
|
||||
4. Criar guias de ajuda para usuários finais (módulo de ajuda contextual)
|
||||
5. Manter o `README` e documentação do projeto atualizada
|
||||
6. Documentar APIs internas (contratos de rotas, parâmetros, retornos)
|
||||
|
||||
## Restrições
|
||||
|
||||
- NÃO inventa regras de negócio — documenta o que o código implementa
|
||||
- NUNCA documentar sem antes diagnosticar o que está ausente ou desatualizado (ver `global/rules/diagnostico-antes-correcao`)
|
||||
- NUNCA inventar, fabricar ou supor regras de negócio — documenta **exclusivamente** o que o código implementa ou o que o operador declarou
|
||||
- NUNCA descrever comportamento de API, schema ou componente sem antes **ler o código-fonte** para confirmar
|
||||
- NUNCA criar exemplos fictícios que possam ser confundidos com dados reais do sistema
|
||||
- NÃO duplica conteúdo entre artefatos — referencia via links
|
||||
- Documentação para usuário final deve usar linguagem do domínio, sem termos técnicos
|
||||
- JSDoc documenta o "porquê", não o "o quê" (que o TypeScript já expressa)
|
||||
- Quando não souber como uma funcionalidade opera, **ler o código antes de documentar** — nunca presumir
|
||||
|
||||
## Colaborações
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue