From abe57e2b4928c29db05b2ef598e3fb09242e2b02 Mon Sep 17 00:00:00 2001 From: Roni Fabio Banaszewski Date: Mon, 28 Sep 2026 13:45:23 -0300 Subject: [PATCH] docs: README deixa de exigir o diagrama ER MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit O README é a vitrine do projeto; o diagrama ER mora só no docs/architecture.md, e o README aponta para ele. Uma cópia no README teria de ser mantida em dois lugares a cada mudança do modelo. Co-Authored-By: Claude Opus 5.5 (1M context) --- docs/architecture.md | 4 ++-- docs/checklist.md | 3 +-- docs/guia-sdd.md | 3 +-- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 29473f7..217ddc4 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -148,8 +148,8 @@ domínio) — com a regra de dependência: features não importam umas das outra ### 📊 5.2. Diagrama ER (Mermaid) -> As tabelas do BaaS e seus relacionamentos — o mesmo diagrama vai renderizado -> no README, como a ficha exige. +> As tabelas do BaaS e seus relacionamentos. O diagrama mora só aqui — o README +> aponta para este documento, sem copiá-lo. ```mermaid erDiagram diff --git a/docs/checklist.md b/docs/checklist.md index 808487b..2c80c3c 100644 --- a/docs/checklist.md +++ b/docs/checklist.md @@ -44,8 +44,7 @@ disciplina ele é chamado de `ssd.md` — é o mesmo documento). - **README.md** com a estrutura exigida: título/nome do app, autores, descrição, links para `docs/prd.md`, `docs/architecture.md` e - `docs/checklist.md`, **diagrama ER em Mermaid renderizado no próprio - README**, link do protótipo (Stitch/Figma), stack (Angular, framework CSS, + `docs/checklist.md`, link do protótipo (Stitch/Figma), stack (Angular, framework CSS, BaaS, bibliotecas), link do site em produção, instruções de execução e imagens de telas. diff --git a/docs/guia-sdd.md b/docs/guia-sdd.md index 8de4c0f..0d9300e 100644 --- a/docs/guia-sdd.md +++ b/docs/guia-sdd.md @@ -184,8 +184,7 @@ Contém: - **Diagrama de contexto (opcional).** Trata o seu sistema como caixa preta e ilustra quem o usa e com que serviços externos ele conversa (o BaaS, autenticação social, mapas, sistema da UTFPR). -- **Modelo de dados (diagrama ER).** As tabelas do BaaS e seus relacionamentos — o - mesmo diagrama que vai renderizado no README. +- **Modelo de dados (diagrama ER).** As tabelas do BaaS e seus relacionamentos. - **Glossário técnico (PT-BR → EN).** A ponte que garante que o PRD em português ("Aplicação") vire a entidade correta em inglês no código e no banco (`apps`), matando o código espanglês.