Documentando tomadas de decisões arquiteturais
2024-11-28 , Jaguatirica room
Language: Português brasileiro

Já se perguntou como documentar uma tomada de decisão arquitetural? Nesta palestra usaremos um exemplo prático para explorar como Architectural Decision Records e o C4 Model podem apoiar neste desafio


Um estudo de 2021 da Microsoft confirmou o quanto a documentação é um dos principais fatores para acelerar o aprendizado de novos desenvolvedores de um time. Apesar de técnicas e ferramentas como UML para diagramas de sequência ou Swagger para APIs, nem sempre encontramos técnicas para documentação de camadas mais abstratas da arquitetura de um software, e ainda precisamos lidar com problemas como manter a documentação atualizada com o código e a informalidade das documentações, que acaba tornando-as mais difíceis de entender pela falta de um padrão. Nesta palestra, vamos através de um exemplo prático de tomada de decisão arquitetural, explorar como o modelo de "Architectural Decision Records" (ADR) e o C4 Model podem apoiar nestes desafios.

A ideia é pensar em um sistema de chats, registrando três opções de arquitetura usando o modelo de ADR: Short Polling, Long Polling e Web Socket. E, para os possíveis componentes do sistema de chats usar o C4 Model para documentação.

Sou uma mulher negra goiana, que se graduou em Engenharia de Software em Brasília e hoje mora em São Paulo. Trabalho há 6 anos com desenvolvimento backend, e participo das comunidades PyLadies e BOSS, uma iniciativa para inclusão de grupos sub representados na comunidade de código aberto. No meu tempo livre eu faço aula de música e pole dance, e gosto muito de cinema, natureza e esportes =)