メニュー
Documentar regras de negócio e contratos da API com rastreabilidade total ao código, garantindo cobertura completa, clareza de consumo e consistência entre backend e frontend.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Orientar mudancas no backend Core em .NET 10 com Clean Architecture. Use quando Codex precisar implementar, corrigir, revisar ou testar funcionalidades deste projeto, especialmente em autenticacao, dashboard, administracao de usuarios e financeiro, navegando entre Core.Api, Core.Application, Core.Domain, Core.Infrastructure, src/tests/Core.Tests, documentacao tecnica e query's.
Atuar como Software Development Engineer in Test em sistemas backend, frontend e APIs. Use quando Codex precisar definir estrategia de testes, identificar lacunas de cobertura, criar ou ajustar testes unitarios, de integracao e ponta a ponta, investigar falhas ou flakiness, revisar risco de regressao, validar cenarios criticos e melhorar a confiabilidade de suites automatizadas.
Criar commits Git com semântica convencional, staging seguro e validação prévia, sempre com mensagens em PT-BR. Usar quando for necessário organizar alterações locais em commits claros, rastreáveis e sem risco de incluir mudanças indevidas.
Atuar como DBA de SQL Server com foco em boas praticas, performance, diagnostico, manutencao, modelagem de dados e scripts seguros. Use quando Codex precisar analisar consultas lentas, investigar bloqueios e deadlocks, revisar indexes, estatisticas e planos de execucao, propor manutencao de banco, avaliar schema e modelagem, escrever scripts T-SQL seguros para producao, revisar impacto de mudancas em dados ou diagnosticar problemas operacionais em SQL Server.
| name | api-rules-documentation |
| description | Documentar regras de negócio e contratos da API com rastreabilidade total ao código, garantindo cobertura completa, clareza de consumo e consistência entre backend e frontend. |
Criar ou atualizar documentação técnica da API garantindo:
Usar references/doc-template.md como base quando não houver template do time.
Destinos padrões:
documentações tecnica/../Core-Front/documentação tecnica/API/A documentação deve ser baseada EXCLUSIVAMENTE em:
Nunca assumir comportamento sem evidência.
Deve conter:
Ao atualizar documentação:
Para cada endpoint:
Se houver DTO compartilhado: → criar seção Contratos completos
Exemplos devem refletir:
Nunca usar:
Para cada endpoint, detalhar:
E também o fluxo:
Descrever explicitamente:
Informar claramente:
Para campos relevantes, documentar:
Nunca usar linguagem vaga.
Para cada erro:
Sempre citar:
Separar:
Replicar documentação em:
../Core-Front/documentação tecnica/API/Manter:
Se não for possível: → registrar no retorno final
Antes de concluir:
Se houver dúvidas:
→ registrar em Pendências
A resposta deve conter: