WWCalc Docs¶
Portal único de documentação técnica do ecossistema WWCalc.
Por que existe este portal¶
- Centralizar documentação transversal entre produtos e times.
- Facilitar acesso rápido à informação, sem depender de acesso a repositórios.
- Reduzir duplicações e manter uma fonte única de verdade.
O que entra no portal¶
- Fluxos compartilhados entre repositórios.
- Contratos de API.
- Arquitetura e integrações.
- Boas práticas e padrões.
O que fica nos repositórios de código¶
- Setup local.
- Deploy específico.
- Troubleshooting específico.
- Detalhes internos de módulos.
Recomendações de escrita¶
- Estrutura padrão: Introdução, Fluxo, Exemplos, Erros.
- Linguagem objetiva e direta.
- Exemplos reais e atualizados.
- Mudanças de API exigem atualização imediata da documentação.
- Governança simples: evite burocracia, priorize clareza.
Governança¶
- Quem revisa: time responsável pelo tema (padrão: plataforma/backend).
- Quando atualizar: toda mudança de fluxo, contrato ou integração.
- Links: quem publica o conteúdo mantém os links corretos.