Gabriel Felipe Souza SantosandCursor
aa75cebaaa
documentation/ fica neutra (produto); visão TP, tutorial Ping e checklists de entrega movem para docs/tp/ sem link reverso. Co-authored-by: Cursor <cursoragent@cursor.com>
1.4 KiB
1.4 KiB
Convenções da documentação
Índice geral: docs/README.md.
Idioma e tom
- Português brasileiro, termos de Redes e Java como no código (
ConnectionManager,MulticastSocket). - Parágrafos completos; evitar listas longas quando um texto curto explica melhor.
Blocos teoria × implementação
Em capítulos de rede e arquitetura, quando um conceito for central, use mentalmente três camadas:
- Teoria — como o protocolo ou padrão funciona em geral (com link para references/README.md se precisar de fonte).
- No Pitiupi — classes e fluxo reais.
- Limitação — o que o projeto não faz (ex.: sem criptografia, sem ICMP nativo no plugin Ping).
Não descreva funcionalidade futura como se já existisse.
Código nos exemplos
- Trechos de tutorial são ilustrativos quando indicado; complete o plugin conforme 10_tutorial_plugin.md.
- APIs citadas devem existir no núcleo atual (
PluginWorkspace,createPlugin(ConnectionManager, PluginWorkspace)).
Diagramas
- Preferir Mermaid em arquivos
.md(GitHub). - Diagramas pequenos, um fluxo por figura.
Manutenção
Alterou protocolo, SPI ou boot? Atualize o capítulo numerado correspondente e, se for decisão estável, decision-register.md. Ver 13_guia_desenvolvimento.md.