RFC, ADR e Postmortem:
a documentação técnica — Staff+ Podcast 05
Uma conversa sobre RFCs, ADRs e Revisão de Incidentes e a importância destas documentações técnicas
No primeiro episódio de 2023 do Staff+ Podcast, Paulo Vasconcellos, Flávio Clésio e Marlesson Santana conversam com um convidado mais do que especial que é o Marco Aurelio Ribeiro (carinhosamente conhecido como Matador) sobre Documentação Tecnica; em especial sobre RFCs (Request for Comments — Requisição para Comentários), ADR (Architecture Design Record — Registro de Decisões Arquiteturais) e Revisão de Incidentes.
Foram discutidos algumas das especificidades de cada uma dessas documentações técnicas, seus objetivos, e como essas são benéficas para uma cultura de engenharia, independentemente do tamanho do time técnico. E aí, bora mergulhar nesse assunto?
Lembrando que você pode encontrar todos os podcasts da família Data Hackers no Spotify, iTunes, Google Podcast, Castbox e muitas outras plataformas. Caso queira, você também pode ouvir o episódio aqui no post mesmo!
Conheça os hosts
Paulo Vasconcellos
Flávio Clésio (Twitter)
Marlesson Santana
Nosso convidado
Falamos no episódio
RFC (Request for Comments — Requisição para Comentários)
- Request for Comments
- Engineering Planning with RFCs, Design Documents and ADRs
- Source Graph RFCs
- Companies Using RFCs or Design Docs and Examples of These
- [RFC] Best Practices for Naming and Merging PRs (A RFC com um pouco mais de 700 comentários ao longo de 2 anos)
- RFC: Officially recommend against using GraphQL Stitching in Gravity
- RFC Template
ADR (Architecture Design Record — Registro de Decisões Arquiteturais)
- ADR Tools
- ADR Github
- ADR Templates
- AWS Prescriptive Guidance Using architectural decision records to streamline technical decision-making for a software development project
- Love Unrequited: The Story of Architecture, Agile, and How Architecture Decision Records Brought Them Together
Revisão de Incidentes
- GitLab — Incident Review
- Lista de revisao de incidentes famosos
- Adaptacao do modelo de relacao causal denominado “Queijo Suico” para incidentes em Machine Learning
- Post Mortem Épico da AWS que derrubou metade da internet
- Post-mortem épico №1: Roblox (que endereça os fatores causais e comunica com a comunidade e investidores)
- Post-mortem épico №2: Gitlab (sobre o evento em que o banco de dados foi apagado)
