Passa al contenuto principale

📐 Estrutura Modular de Documentação

Data: 27 de fevereiro de 2026
Padrão: Documentação organizada por camada/módulo (como o código)

🏗️ Arquitetura de Documentação​

📦 booking-management/
│
├── 📄 README.md (projeto principal)
│
├── 📁 docs/ (Central de Testes)
│   ├── 📄 README.md (hub principal)
│   ├── 📄 INDEX.md (entrada testes)
│   ├── 📄 STRUCTURE.md (este ficheiro)
│   ├── 📁 testing/ (Testes em detalhe)
│   │   ├── TESTING-ARCHITECTURE.md (visão completa)
│   │   ├── MODULAR-TESTING-GUIDE.md (quick start)
│   │   └── INDEX-MODULAR-TESTING.md (referência)
│   └── [outros documentos existentes...]
│
├── 📁 frontend/
│   ├── 📁 docs/ (Docs Frontend) ✨ NOVO
│   │   ├── 📄 README.md (índice)
│   │   ├── 📄 TESTING.md (testes E2E)
│   │   └── 📄 LOGIN-TESTING.md (testes login)
│   ├── 📁 tests/e2e/
│   │   ├── 00-auth-login/
│   │   │   ├── login.spec.ts (⚡ fast)
│   │   │   ├── login.videos.spec.ts (🎬 slow)
│   │   │   └── README.md
│   │   └── ...
│   ├── 📁 src/ (código React)
│   └── 📄 package.json
│
├── 📁 backend/
│   ├── 📁 docs/ (Docs Backend) ✨ NOVO
│   │   ├── 📄 README.md (índice)
│   │   └── 📄 TESTING.md (módulo testing)
│   ├── 📁 src/
│   │   ├── 📁 modules/testing/
│   │   │   ├── routes.py (API)
│   │   │   ├── artifacts.py
│   │   │   ├── video_generator.py
│   │   │   └── models/test_run.py
│   │   └── 📁 core/
│   └── 📄 pyproject.toml
│
├── 📁 infrastructure/
│   └── [docs futuro]
│
└── 📁 e2e/ (se necessário)
    └── [docs futuro]

📍 Padrão Modular​

Cada camada/módulo segue o mesmo padrão:

componente/
├── docs/
│   ├── README.md          (índice do componente)
│   ├── TESTING.md         (testes específicos)
│   ├── ARCHITECTURE.md    (opcional, para componentes grandes)
│   └── [outras docs]
├── src/ ou tests/         (código)
└── [ficheiros config]

🔍 Como Navegar​

Procuro documentação de...​

Preciso deVejaLocalização
Testes (visão geral)docs/README.md🔵 Central
Arquitetura de testesdocs/INDEX.md🔵 Central
Testes frontend (detalhes)frontend/docs/TESTING.md🟢 Frontend
Testes login (especial)frontend/docs/LOGIN-TESTING.md🟢 Frontend
Testes backend (API)backend/docs/TESTING.md🔴 Backend
Testes rápidos loginfrontend/tests/e2e/00-auth-login/login.spec.ts🟢 Frontend
Testes vídeos loginfrontend/tests/e2e/00-auth-login/login.videos.spec.ts🟢 Frontend

✅ Vantagens do Padrão Modular​

✅ Coesão: Docs perto do código que documentam
✅ Escalabilidade: Novos componentes seguem mesmo padrão
✅ Navegabilidade: Links relativos funcionam bem
✅ Manutenção: Cada equipe cuida de suas docs
✅ Reutilização: Refs cruzadas bem estruturadas
✅ Versionamento: Git histórico preservado por camada

📊 Status da Reorganização​

ComponenteDocsÍndiceStatus
Centraldocs/docs/README.md✅
Testesdocs/testing/docs/INDEX.md✅
Frontendfrontend/docs/frontend/docs/README.md✅
Backendbackend/docs/backend/docs/README.md✅
Infrastructure--⏳ Próximo
E2E--⏳ Próximo

🔗 Links Rápidos​

Entradas principais:

Testes em detalhe:

💡 Exemplos de Navegação​

Cenário 1: Quero executar testes de login​

docs/README.md → docs/INDEX.md → docs/testing/MODULAR-TESTING-GUIDE.md
                                  ↓
                        "Vejo a instrução rápida"
                                  ↓
                    frontend/tests/e2e/00-auth-login/

Cenário 2: Quero entender arquitetura de testing​

frontend/docs/README.md → frontend/docs/TESTING.md → backend/docs/TESTING.md
                                                      ↓
                                            docs/testing/TESTING-ARCHITECTURE.md

Cenário 3: Quero adicionar novo teste​

frontend/docs/README.md → docs/STRUCTURE.md
                          ↓
                    "Sigo padrão modular"
                          ↓
                    nova-feature/
                    ├── docs/README.md
                    └── nova-feature.spec.ts

Criado: 27 de fevereiro de 2026
Padrão: Modular por camada (como código)
Próximo: Aplicar mesmo padrão a infrastructure/ e e2e/

Ultimo aggiornamento il da CI Governance Bot