Skip to content

docs: especificacao do sistema da Sprint 1 - #18

Merged
NicolasArthurDev merged 28 commits into
devfrom
docs/especificacao-sprint-1
Sep 17, 2026
Merged

NicolasArthurDev merged 28 commits into
devfrom
docs/especificacao-sprint-1

Conversation

@thnbi

@thnbi thnbi commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

O que mudou

  • Cinco documentos novos em docs: requisitos, regras de negócio, casos de uso, diagramas de blocos e fluxogramas
  • Diagrama de blocos e diagrama de casos de uso em draw.io, exportados como SVG com o fonte embutido
  • Quatro fluxogramas em mermaid, dentro do próprio documento
  • docs/requisitos.md reescrito contra a arquitetura alvo dos ADRs, com o piso de custo do EKS anotado como risco
  • docs/requisitos-mvp.md e docs/limitacoes-conhecidas.md removidos, junto com as seções do README que apontavam para eles
  • README com índice da especificação. A descrição do projeto vive na abertura dele, e o docs/resumo.md foi removido por duplicar isso

Por quê

Entrega da Sprint 1 da disciplina ISN, que pede a especificação do sistema. Os documentos que
existiam eram do recorte do MVP e descreviam SQLite, organização hierárquica e ausência de
autenticação, tudo substituído pelos ADRs 0012 a 0030.

A especificação descreve a edição Enterprise e a arquitetura alvo, não o que está implantado.

O diagrama de blocos usa ícones do Kubernetes nos workloads e formas neutras no resto, sem
marca de nuvem, para que o mesmo desenho continue valendo no self-host.

Cliente é o termo único para tudo que consome o markupp, e agente de IA é cliente de primeira
classe: o diagrama de casos de uso diz isso por generalização, com Usuário e Agente de IA
herdando de Cliente.

Fecha #12, #13, #14, #15, #16, #17.

Como testar

  • Abrir os cinco documentos e conferir se os dois SVGs e os quatro blocos mermaid renderizam no GitHub
  • Conferir que nenhum link do README aponta para arquivo removido
  • Comparar as regras de negócio com os ADRs 0012, 0013, 0016, 0020, 0021, 0022, 0024 e 0029

Auto-review (checklist)

  • Descrição clara (o que/por quê/como testar)
  • PR pequeno e focado
  • Casos limite considerados (ex.: vazio, 0, erro)
  • Evidência de teste (manual ou automatizado)

@thnbi thnbi self-assigned this Sep 15, 2026
@thnbi thnbi added documentation Improvements or additions to documentation isn Disciplina ISN 75620501, edicao 2026.2 labels Sep 15, 2026
@thnbi thnbi mentioned this pull request Sep 16, 2026
4 tasks done

@NicolasArthurDev NicolasArthurDev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@NicolasArthurDev
NicolasArthurDev merged commit 34f1ac3 into dev Sep 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation isn Disciplina ISN 75620501, edicao 2026.2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants