2026-01-18 — Auditoria de Documentação (Docs Quality Gate)
Documentação KOLOS

2026-01-18 — Auditoria de Documentação (Docs Quality Gate)

Contexto

O projeto já possui documentação extensa, porém a cobertura de rotas e regras de acesso estava distribuída e, em alguns casos, implícita (ex.: “rota protegida” sem path/name). Isso aumenta risco de erro operacional e dificulta manutenção.

Decisão

  • Executar uma auditoria dos índices e da cobertura de rotas/commands.
  • Criar um registro central (fonte única) de rotas/commands/channels.
  • Formalizar um padrão mínimo de documentação para mudanças futuras.

Escopo da auditoria

  • Índices: docs/README.md, docs/architecture/README.md, docs/changes/README.md, docs/runbooks/README.md
  • Rotas/commands/channels: routes/web.php, routes/console.php, routes/channels.php
  • Mudanças recentes relevantes (ex.: auth, onboarding, localização atual, venue/courts)

Achados

  • docs/changes/README.md: índice presente e consistente.
  • Documentos de mudança variam no nível de detalhe; alguns citam “rota protegida” mas não explicitam METHOD /path + route name.
  • Rotas e commands estavam espalhados por diferentes docs; faltava um registro central.

Ações tomadas

  • Criado registro central:
    • docs/architecture/kolos_registro-de-rotas.md
  • Criado padrão mínimo (doc-first):
    • docs/architecture/kolos_padrao-documentacao.md
  • Ajustadas mudanças para incluir rotas explícitas quando necessário.

Validação

  • sail artisan route:list
  • sail artisan list
  • sail artisan test

Impacto

  • A partir de hoje, qualquer rota/command nova deve aparecer no documento de mudança e no registro central.