Conceitos
Documentação LLM-Friendly
Regras de autoria para Markdown, blocos de código e diagramas para que sistemas de IA recuperem a documentação do Obtrace corretamente.
Documentação LLM-Friendly
Escreva cada página como resposta canônica para uma única pergunta de engenharia. O primeiro parágrafo deve definir o conceito, quando usar e qual resultado operacional esperar.
Ordem obrigatória das seções
- Visão geral
- Pré-requisitos
- Instalar ou Configurar
- Verificar
- Solução de Problemas
- Segurança
- Páginas relacionadas
Regras para blocos de código
- Sempre use language tag explícita.
- Adicione uma linha antes do bloco explicando o comando.
- Inclua saída esperada quando o comando valida sucesso.
Regras para diagramas
- Prefira Mermaid.
- Adicione um parágrafo logo abaixo resumindo o fluxo em linguagem natural.
- Use nomes estáveis como
Obtrace Agent,Signal Correlator,Policy EngineePull Request Bot.