Documentação do Projeto¶
Bem-vindo à documentação do sistema Root Book, um sistema de produtividade pessoal desenvolvido como MVP (Versão 1).
O sistema é composto por dois grandes blocos funcionais:
- Sistema de Autenticação — camada de acesso e identidade, responsável por proteger e isolar os dados de cada usuário.
- Sistema de Tarefas — camada funcional principal, responsável por produtividade (tarefas) e agenda (compromissos), organizadas hierarquicamente dentro de Cadernos pertencentes a um usuário autenticado.
Navegação Rápida¶
Engenharia de Requisitos¶
Toda a especificação de requisitos do sistema, desde o glossário até a matriz de rastreabilidade.
| Documento | Descrição |
|---|---|
| Glossário | Dicionário de domínio do sistema |
| Goals (KAOS) | Metas do sistema usando o framework KAOS |
| Requisitos | Requisitos funcionais e não-funcionais |
| Épicos | Épicos do produto |
| Casos de Uso | Especificação dos casos de uso |
| Diagrama de Casos de Uso | Representação visual dos casos de uso |
| User Stories | Histórias de usuário |
| Tasks | Tarefas de implementação |
| Casos de Teste | Cenários de teste |
| Matriz de Rastreabilidade | Rastreabilidade entre artefatos |
Arquitetura de Software¶
Documento de Arquitetura de Software (DAS) com visões C4, decisões arquiteturais e análise de riscos.
| Documento | Descrição |
|---|---|
| Visão Geral (DAS) | Visão geral da arquitetura |
| Contexto e Contêiner (C4) | Diagramas C4 de contexto e contêiner |
| ASRs | Requisitos Arquiteturalmente Significativos |
| ADRs | Architecture Decision Records |
| Riscos e Dívida Técnica | Análise de riscos e dívida técnica |
Design de Software¶
Contratos de API e modelagem de dados.
| Documento | Descrição |
|---|---|
| Contratos de API | Especificação dos contratos da API REST |
| Modelo de Dados | Modelo de dados do sistema |
Processos¶
Processos de desenvolvimento, padrões e guias.
| Documento | Descrição |
|---|---|
| Engenharia de Requisitos | Processo de engenharia de requisitos |
| Arquitetura de Software | Processo de arquitetura de software |
| Especificação de API | Processo de especificação de API |
| Modelagem de Dados | Processo de modelagem de dados |
| Padrões de Codificação | Padrões e convenções de código |
| Desenvolvimento e Entrega (Kanban) | Processo de desenvolvimento e entrega |
Planejamento¶
| Documento | Descrição |
|---|---|
| Especificação do Sistema | Especificação completa do MVP |
| Plano de Implementação | Plano de implementação do MVP v1 |
| Branch Names – Fase A | Convenção de nomes de branches |
Como contribuir
Para contribuir com a documentação, edite os arquivos Markdown na pasta docs/ e submeta um Pull Request.