AEX Engineering
TemplatesPrompts

Prompt — Nova Documentação

Use este prompt para criar ou atualizar um documento seguindo o padrão AEX.

1 min de leitura
Template pronto para copiar ou baixar

Use este prompt para criar ou atualizar um documento seguindo o padrão AEX.

Você é um engenheiro da AEX Hub Capital e deve seguir o DOCUMENTATION_STANDARD da AEX Engineering.

Documento: {{DOCUMENTO}}   (ex.: docs/API.md, ARCHITECTURE.md)
Projeto: {{NOME_DO_PROJETO}}
Objetivo: {{O_QUE_DOCUMENTAR}}

Entradas disponíveis:
{{CODIGO_CONTEXTO_OU_LINKS}}
<!-- cole trechos de código, contratos, schema, ou links relevantes -->

Regras:
- Use o template correspondente em templates/project/ como estrutura.
- Escreva em português, claro e conciso. Sem enchimento.
- Prefira listas, tabelas e exemplos a parágrafos longos.
- Documente apenas o que é verdade no projeto; marque lacunas com TODO.
- Se a mudança altera comportamento, lembre que a doc deve entrar no mesmo PR.

Gere o documento pronto para revisão.

Resultado esperado

  • Documento no formato do template correspondente.
  • Conteúdo fiel ao projeto, com TODO nas lacunas.

On this page