arc42

Um template gratuito e open source para documentação de arquitetura de software, organizado em doze seções, dos objetivos e do contexto até os riscos e o glossário.

O que é arc42?

O arc42, criado por Peter Hruschka e Gernot Starke, estrutura a documentação de arquitetura em doze seções: introdução e objetivos, restrições, contexto e escopo, estratégia da solução, visão de blocos de construção, visão de runtime, visão de deployment, conceitos transversais, decisões de arquitetura, requisitos de qualidade, riscos e dívida técnica, e glossário. Ele não prescreve nenhuma notação de diagrama, por isso as equipes costumam desenhar diagramas C4 dentro dele: o diagrama de contexto na seção 3, os diagramas de contêineres e de componentes na visão de blocos de construção (seção 5) e os diagramas dinâmicos na visão de runtime (seção 6). A orientação do próprio arc42 é documentar apenas o que os leitores precisam, em vez de preencher todas as seções.

Também conhecido como: arc42 template.

Termos relacionados

  • Modelo C4 — Uma abordagem leve de visualização de arquitetura que descreve sistemas de software em quatro níveis: Contexto de Sistema, Contêiner, Componente e Código.
  • Architecture Decision Record (ADR) — Um documento curto que captura uma única decisão arquiteturalmente significativa, seu contexto e suas consequências.
  • Documentação Viva — Documentação que é gerada ou validada a partir do sistema em execução, de modo que permanece precisa à medida que o sistema evolui.

Saiba mais