Apresentação sobre Documentação profissional com C4 model, feita duramente o DevFest 2023 Pelotas GDG

1. Documentação
Profissional Com
C4 Model
Pelotas

2. - Cristiano Cunha
- Desenvolvedor .NET
- Arquitetura
- Pelotas
Quem sou eu

3. O que teremos hoje
Documentação
{01}
Diagram as Code
{03}
{02}
C4 Model
Dicas
{04}

4. Documentação
Pelotas

5. Software em funcionamento
mais que documentação
abrangente
Manifesto Ágil

6. Alguns "traduzem" essa frase
como:
NÃO DOCUMENTAR NADA!
Programador com preguiça

7. Na maioria dos casos
precisamos documentar, nem
que seja o básico!

8. Quanto maior o risco e
complexidade, maior a
probabilidade de você ter que
documentar

9. Por que documentar?
● Onboarding de pessoas no time
● Bus Factor
● Facilidade na comunicação / discussões
● Troubleshooting mais rápido
● …

10. Problemas

11. Padronização

12. Mesma solução diferentes desenhos

13. UML?

14. C4 Model
Pelotas

15. Primeiro, visão geral;
depois, amplie e filtre;
em seguida, detalhes
sob demanda
Ben Shneiderman, 1996

16. The Eyes Have It: A Task by
Data Type Taxonomy for
Information Visualizations
Ben Shneiderman, 1996

18. Vai dando zoom nas
camadas

23. Context
Tem como objetivo ser o ponto de entrada,
uma visão geral!
Publico alvo: Pessoas técnicas e não
técnicas

24. Pessoa

25. Software Systems

26. Enterprise Boundary

27. Interações

29. Container
Ter uma visão mais detalhada da arquitetura,
quais os serviços fazem parte, e como se
comunicam
Publico alvo: Pessoas técnicas, Dev, DBA,
QA...

30. Container

31. Container

32. Armazenamento - Banco de Dados

33. Mensageria*

37. Component
O mais próximo do código, usado para
discutir fluxos dentro do seu APP/API...
Publico alvo: Time que vai desenvolver a
solução

38. Component

40. Code
Foco em diagramas próximos de código,
como o de classe
Publico alvo: quem vai desenvolver a
solução

41. Notação

42. A abstração é mais
importante que a
notação!

43. Tenha um bom título
E uma boa legenda

44. Ferramentas

45. Excalidraw

46. Miro

47. Como manter
atualizado?

48. Diagram As Code
Pelotas

49. Plant
UML

52. Mermaid

55. Dicas
Pelotas

56. The
software
guidebook

57. The C4 model
for visualising
software
architecture

58. Por onde começar?

59. Diagrama de contexto

60. Documentação + Código
tem que ser mais barato
que só código
Elemar Jr.

61. Obrigado!
cristianoprogramador.com

62. Obrigado!
cristianoprogramador.com