Skip to content

docs: um passeio guiado pela arquitetura, e o mapa vira diagrama - #12

Merged
kerlonr merged 1 commit into
mainfrom
docs/como-funciona
Sep 3, 2026
Merged

docs: um passeio guiado pela arquitetura, e o mapa vira diagrama#12
kerlonr merged 1 commit into
mainfrom
docs/como-funciona

Conversation

@kerlonr

@kerlonr kerlonr commented Sep 3, 2026

Copy link
Copy Markdown
Member

O que é

Faltava um documento que respondesse "como isso funciona?" para quem nunca viu o projeto. O docs/ explica como instalar cada frente e o contrato-mqtt.md explica o formato das mensagens — mas nenhum dos dois conta a história de ponta a ponta.

COMO-FUNCIONA.md conta, em quinze minutos e com diagramas Mermaid:

  • as duas jornadas que definem o repositório: a de ida (dedo no botão até o motor girar, em oito passos) e a de volta (posição do GPS até o gráfico no celular, em sete);
  • os cinco serviços do Pi numa tabela: o que cada um assina, o que publica, o que faz;
  • as três camadas de motores/, e por que as duas de baixo rodam sem robô;
  • o barramento MQTT inteiro numa tabela — inclusive os dois tópicos que ainda não têm consumidor;
  • as três camadas independentes de segurança de movimento, e por que são três: cada uma cobre a falha da anterior;
  • as duas armadilhas que já custaram caro (dois brokers na 1883, e os serviços não instalados no robô).

O mapa ganhou um diagrama de verdade

O ASCII de 30 linhas do MAPA-COMUNICACAO.md era legível no editor e não dizia quem falava com quem sem esforço. Virou Mermaid — com duas ressalvas escritas embaixo, porque um diagrama bonito que mostra serviços inexistentes é pior que nenhum:

  1. as setas para os serviços do pi/services/ são planta, não construção (ver a §0);
  2. os tópicos de voz e rota ainda não têm quem os consuma.

Verificação

  • 135 testes continuam passando (API 37, motores 52, roteador 30, wifi 16)
  • o diagrama do mapa e os 4 do documento novo foram validados com o mermaid-cli

🤖 Generated with Claude Code

https://claude.ai/code/session_0173mr3mDsAKQuPUNaPghe9v

Faltava um documento que respondesse **"como isso funciona?"** para quem nunca
viu o projeto. O `docs/` explica como instalar cada frente e o
`contrato-mqtt.md` explica o formato das mensagens, mas nenhum dos dois conta a
historia de ponta a ponta.

`COMO-FUNCIONA.md` conta, em quinze minutos e com diagramas Mermaid:

- as duas jornadas que definem o repositorio: a de ida (dedo no botao ate o
  motor girar, em oito passos) e a de volta (posicao do GPS ate o grafico no
  celular, em sete);
- os cinco servicos do Pi numa tabela: o que cada um assina, o que publica, o
  que faz;
- as tres camadas de `motores/`, e por que as duas de baixo rodam sem robo;
- o barramento MQTT inteiro numa tabela, com quem publica e quem consome —
  inclusive os dois topicos que ainda nao tem consumidor;
- as tres camadas independentes de seguranca de movimento, e por que sao tres:
  cada uma cobre a falha da anterior;
- as duas armadilhas que ja custaram caro (dois brokers na 1883, e os servicos
  nao instalados no robo).

**E o `MAPA-COMUNICACAO.md` ganhou um diagrama de verdade.** O ASCII de 30
linhas era legivel no editor e nao dizia quem falava com quem sem esforco;
virou Mermaid, que o GitHub renderiza — com duas ressalvas escritas embaixo,
porque um diagrama bonito que mostra servicos inexistentes e pior que nenhum:
as setas para os servicos do `pi/services/` sao planta, nao construcao, e os
topicos de voz e rota ainda nao tem quem os consuma.

135 testes continuam passando. O diagrama do mapa e os 4 do documento novo
foram validados com o `mermaid-cli`, nao so escritos.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0173mr3mDsAKQuPUNaPghe9v
@kerlonr
kerlonr merged commit 98ee681 into main Sep 3, 2026
@kerlonr
kerlonr deleted the docs/como-funciona branch September 3, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant