Home - manolito-fatec/dashflow-2025-1 GitHub Wiki
Bem-vindo à Nossa Documentação!
Olá! 👋 Esta wiki serve como base central de conhecimento para nosso projeto, contendo documentação tanto de Desenvolvimento quanto de DevOps.
Convenção de Prefixos na Documentação
Para facilitar a organização e identificação rápida dos documentos, adotamos a seguinte convenção:
DO - DevOps (Operações)
Exemplos:
DO - Infraestrutura Cloud
DO - Pipeline CI/CD
DO - Monitoramento
O que incluir em DO:
- Configurações de infraestrutura
- Processos de deploy
- Ferramentas de operações
- Automações de ambiente
DEV - Desenvolvimento
Exemplos:
DEV - Padrões de Código
DEV - Arquitetura da API
DEV - Guia de Contribuição
O que incluir em DEV:
- Padrões de desenvolvimento
- Documentação de features
- Guias de implementação
- Fluxos de trabalho
✅ Benefícios:
- 🔍 Busca facilitada - Filtre por prefixo
- � Contexto imediato - Entenda o foco do documento
- 📂 Organização intuitiva - Agrupamento natural
- 🚀 Onboarding acelerado - Nova equipe entende rápido