Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 2.77 KB

README.md

File metadata and controls

80 lines (63 loc) · 2.77 KB

📁 Documentação do Projeto PROAE

Repositório centralizado para toda a documentação relacionada ao sistema de gestão da PROAE/UFBA. Organização do Projeto: TSIW-PROAE

📂 Estrutura de Pastas

1. project_management/

Documentação relacionada à gestão do projeto ├── meeting_minutes/ - Atas de reunião no formato YYYY-MM-DD-ata.md ├── timelines/ - Cronogramas, roadmap e planos de entrega └── deliverables/ - Entregas formais e relatórios de progresso

2. technical_documentation/

Documentação técnica do sistema ├── architecture/ │ ├── Diagramas (C4, UML, fluxos) │ └── Documentos arquiteturais (system-architecture.md) ├── infrastructure/ │ ├── Configuração de servidores │ └── Políticas de deploy (deployment.md) └── code_docs/ ├── frontend/ - Componentes, fluxos e decisões do frontend └── backend/ - Especificações de serviços e API

3. requirements/

Requisitos e casos de uso ├── functional-requirements.md - Lista de requisitos funcionais ├── non-functional-requirements.md - Requisitos não funcionais └── use_cases/ - Cenários de uso detalhados

4. design/

Design do sistema e UI/UX ├── ui-ux/ │ ├── wireframes/ - Protótipos de baixa fidelidade │ └── mockups/ - Designs de alta fidelidade └── style_guide/ - Guia de estilos e componentes

5. guidelines/

Diretrizes e padrões ├── coding-standards.md - Convenções de código ├── git-convention.md - Fluxo de trabalho com Git └── contribution-guide.md - Como contribuir

6. references/

Materiais de referência ├── third-party-docs/ - Documentação de tecnologias utilizadas └── research/ - Pesquisas técnicas e benchmarks

7. miscellaneous/

Documentos diversos ├── proposals/ - Propostas iniciais e esboços └── legal/ - Documentação jurídica e contratos

📝 Templates Disponíveis

  1. Atas de Reunião: project_management/meeting_minutes/TEMPLATE.md

⚙️ Como Contribuir

  1. Escolha a pasta adequada para seu documento
  2. Siga as convenções de nomenclatura:
    • Datas no formato YYYY-MM-DD
    • Nomes em inglês para documentos técnicos
    • Versione arquivos quando necessário (doc-v1.md, doc-v2.md)
  3. Adicione entradas relevantes nos READMEs das pastas

🔒 Licença

Documentação sob licença Creative Commons Attribution 4.0

📬 Contato: Equipe TSIW-PROAE - tsiw-proae@ufba.br Página da Organização