documentation-strategy
# Documentation Strategy ## Objetivo Ter documentacao minima desde o inicio e evoluir para uma referencia interativa sem travar a entrega do servico. ## Portas e rotas Nao e necessario abrir uma porta separada para docs. A estrategia recomendada e expor as rotas no mesmo processo HTTP: - `/docs` - `/docs/scalar` - `/docs/openapi.yaml` - `/docs/async` - `/docs/asyncapi.yaml` - `/docs/concepts` ## Fases ### Fase 1 - docs minimas no repositorio - rotas HTTP basicas - Scalar consumindo o OpenAPI local ### Fase 2 - AsyncAPI mais detalhado - mais paginas de conceitos - ADRs adicionais ### Fase 3 - refinamento visual - autenticao/protecao de docs se necessario - eventualmente um portal separado, caso isso faca mais sentido do que servir tudo no proprio processo