developer-docs

name	developer-docs
description	Planejar e manter documentação técnica do projeto (README, quickstart, ADRs, docs internas, exemplos de tool calls e troubleshooting) alinhada ao código; usar quando o pedido exigir clareza documental e não usar para implementar lógica de runtime ou infraestrutura.

Developer Docs

1) Objetivo e Escopo

Manter documentação técnica acionável, atualizada e consistente com o comportamento real do Code Compass.

Trigger policy

• Disparar quando o pedido mencionar README, apps/docs/pages, ADRs, quickstart, runbook, exemplos de tool calls, troubleshooting ou atualização de documentação após mudança técnica.
• Disparar quando houver divergência entre comportamento do sistema e instruções documentadas.
• Não disparar para implementação de feature em runtime (developer-mcp-server, developer-indexer, developer-vector-db, developer-infra) sem foco documental explícito.

2) Entradas esperadas

• Público-alvo (dev, operação, mantenedor, reviewer).
• Escopo do documento e contexto técnico da mudança.
• Fonte de verdade (arquivos de código, comandos reais, decisões arquiteturais).
• Restrições de formato/idioma e nível de detalhe desejado.

3) Workflow (Discovery -> Plan -> Implement -> Validate -> Deliver)

1. Discovery
   • Ler arquivos de código e configs relevantes antes de editar docs.
   • Levantar lacunas, inconsistências e comandos obsoletos.
   • Consultar references/checklist.md para padrão de qualidade documental.
2. Plan
   • Definir estrutura mínima por seção (objetivo, pré-requisitos, execução, validação, troubleshooting).
   • Priorizar clareza operacional e exemplos executáveis.