Contribuições devem tornar a modelagem mais clara, rastreável ou implementável.
- exemplos de diagram-as-code;
- templates menores e mais úteis;
- correções de notação UML/BPMN/C4;
- exemplos de OpenAPI/AsyncAPI;
- rastreabilidade e ADRs;
- automação para validar documentação.
Issue → branch → mudança focada → validação → PR → review → merge
- não publicar secrets, IPs, endpoints sensíveis, dados de clientes ou requisitos confidenciais;
- separar fatos do sistema de hipóteses/propostas;
- em sistemas existentes, documentar AS-IS antes do TO-BE;
- preferir fonte editável + render;
- não criar diagramas apenas para aumentar volume de documentação;
- usar fonte primária ao atualizar padrões e especificações.
Inclua problema, artefatos alterados, motivo da notação escolhida e como validar a mudança.