Documentação: guias de uso (Node/Python) + política de PII/redaction + checklist de integração

[4lessandrodev]

Visão geral

Criar documentação acionável para que qualquer contribuidor consiga integrar observability sem conhecer o projeto.

Contexto

Observability é frequentemente mal integrado (logs inconsistentes, PII em logs, ausência de request_id). O projeto precisa de guias explícitos e checklist.

Descrição

Criar/atualizar documentos em docs/:

• usage-node.md: como registrar plugin e emitir eventos
• usage-python.md: como usar run_context e stages
• pii-redaction.md: o que é proibido, como redaction funciona
• metrics.md: quais métricas existem, como habilitar
• traces.md: como habilitar OTel (feature flag)

Incluir checklist de integração:

• request_id e header
• não logar q bruto
• usar query_hash
• status/duration em eventos
• validação contra schema em CI

Impacto

Reduz bugs, acelera adoção e melhora postura defensiva do projeto (PII/risco).

Referências

• https://github.com/OpenAudit-Brasil/openaudit-observability/blob/main/README.md
• https://github.com/OpenAudit-Brasil/About/blob/main/SECURITY.md
• https://github.com/OpenAudit-Brasil/About/blob/main/RISK_POLICY.md
• https://github.com/OpenAudit-Brasil/About/blob/main/CODE_OF_CONDUCT.md

Definição de pronto

• Docs adicionados/atualizados
• Checklist presente e referenciado no README
• Exemplos no doc correspondem aos pacotes reais
• Guia deixa explícito como evitar PII

Tags

• priority:medium
• type:docs
• area:docs
• area:security
• good first issue