Documentação Completa

Esta página serve como índice centralizado para toda a documentação técnica e de projeto do FinBoost+. A documentação está distribuída em diferentes locais para atender às necessidades específicas de cada público e tipo de informação.

Estrutura da Documentação

Documentação no MkDocs (Este Site)

Esta documentação técnica está organizada para usuários, desenvolvedores e avaliadores do projeto.

Para Usuários Finais

• Guia do Usuário - Como usar a aplicação
• FAQ - Perguntas frequentes

Para Desenvolvedores e Avaliadores

• Arquitetura e API - Visão técnica do sistema
• Frontend - Estrutura e padrões do frontend
• Backend - Estrutura e padrões do backend
• Transparência de IA - Registro do uso de IA no projeto

Documentação no GitHub

Arquivos Principais do Repositório

README.md Principal

• Visão geral do projeto para visitantes do GitHub
• Quick start e instruções básicas
• Links para documentações mais detalhadas
• Acesso: GitHub - README

CONTRIBUTING.md

• Guia detalhado para contribuidores
• Padrões de código e commit
• Processo de pull requests
• Acesso: GitHub - Contributing

LICENSE

• Licença do projeto (MPL-2.0)
• Acesso: GitHub - License

Diretório project_docs/

Contém documentos extensos de planejamento e especificação do projeto:

Documento MVP Completo

• Especificação detalhada do Produto Mínimo Viável
• Mais de 900 linhas com requisitos técnicos e funcionais
• Diagramas de arquitetura e banco de dados
• Acesso: GitHub - MVP

Personas Detalhadas

• Perfis completos dos usuários-alvo
• Cenários de uso e necessidades específicas
• Jornadas do usuário mapeadas
• Acesso: GitHub - Personas

Histórias de Usuário

• Especificação detalhada de todos os recursos
• Critérios de aceitação por funcionalidade
• Priorização e estimativas
• Acesso: GitHub - User Stories

Documento de Requisitos

• Requisitos funcionais e não funcionais
• Restrições técnicas e de negócio
• Matriz de rastreabilidade
• Acesso: GitHub - Requisitos

Contrato de API

• Especificação completa de todos os endpoints
• Modelos de dados e schemas
• Códigos de resposta e tratamento de erros
• Acesso: GitHub - API Contract

GitHub Wiki

A Wiki contém documentação técnica voltada para desenvolvedores durante o processo de desenvolvimento:

Processo de Desenvolvimento

• Estrutura do Repositório
• Como Rodar o Projeto
• Boas Práticas de Desenvolvimento

Padrões Técnicos

• Padrão de Commits
• GitFlow e Branching
• Code Review Guidelines

Deploy e Infraestrutura

• Configuração de Ambiente
• Deploy Local com Docker
• Testes Automatizados

Planejamento

• Roadmap Detalhado
• Retrospectivas de Sprint
• Decisões Arquiteturais

Acesso à Wiki: GitHub Wiki

Documentação da API (Swagger/Scalar)

Documentação Interativa

• Interface web para explorar e testar todas as APIs
• Schemas de dados automaticamente gerados
• Exemplos de requisições e respostas
• Acesso: Disponível quando a aplicação está rodando em /swagger-ui.html

Para desenvolvedores: Consulte API - Guia Rápido para instruções de acesso.

Notion - Hub de Documentação (Interno)

O Notion serve como hub centralizado para documentação de processos, planejamento e acompanhamento do projeto (acesso restrito à equipe):

Planejamento e Gestão

• Backlog detalhado com priorização
• Sprint planning e retrospectives
• Acompanhamento de métricas do projeto
• Documentação de reuniões e decisões

Conhecimento Compartilhado

• Tutoriais e guias técnicos
• Troubleshooting comum
• Links úteis e recursos de aprendizado
• Templates e checklists

Gestão de Equipe

• Divisão de tarefas e responsabilidades
• Timeline de entregas

Mapa de Navegação da Documentação

flowchart TD
    Start([Acesso ao FinBoost+]) --> Question{O que você busca?}

    Question -->|Usar o app| Use[Experiência do Usuário]
    Question -->|Avaliar projeto| Eval[Avaliação do Projeto]
    Question -->|Contribuir| Dev[Desenvolvimento]
    Question -->|Entender sistema| Arch[Arquitetura Técnica]

    Use --> UseRes[README + Guia<br/> FAQ + Suporte]

    Eval --> EvalRes[Visão Geral<br/>MVP Summary<br/>Equipe]

    Dev --> DevRes[CONTRIBUTING<br/>Setup Local<br/>Padrões]

    Arch --> ArchRes[Documentação Técnica<br/>API Reference<br/>Database Design]

    classDef startStyle fill:#f3e5f5,stroke:#7b1fa2,stroke-width:3px
    classDef questionStyle fill:#fff3e0,stroke:#f57c00,stroke-width:2px
    classDef pathStyle fill:#e8f5e8,stroke:#388e3c,stroke-width:2px
    classDef resultStyle fill:#e3f2fd,stroke:#1976d2,stroke-width:1px

    class Start startStyle
    class Question questionStyle
    class Use,Eval,Dev,Arch pathStyle
    class UseRes,EvalRes,DevRes,ArchRes resultStyle