| Introdução

A arquitetura de software é um componente crucial no desenvolvimento de sistemas complexos. Compreender, comunicar e documentar essa arquitetura são desafios comuns enfrentados pelas equipes de desenvolvimento. A metodologia C4 (Context, Containers, Components e Code) foi desenvolvida por Simon Brown como uma abordagem para abordar esses desafios. Neste artigo, exploraremos o que é a documentação C4, por que é importante e como ela pode beneficiar equipes de desenvolvimento de software.

| Importância da Comunicação Arquitetural Eficaz

• Tomada de Decisões Informadas: Compreensão clara da arquitetura facilita decisões acertadas em desenvolvimento e design.

• Colaboração Produtiva: Uma linguagem arquitetural comum promove colaboração e entendimento mútuo.

• Manutenção Sustentável: Documentação clara é essencial para a manutenção contínua e a evolução saudável do software.
  

| Alguns exemplos de diagramas desorganizados

Comumente nos deparamos com a construção de diagramas de arquitetura de software sem uma notação única, nomenclatura ambígua, relações sem rótulo, abstrações mistas e sem opções de tecnologia. E, com o advento de um fluxo de execução mais ágil, diversas equipes abandonaram linguagens de modelagem já concebidas na indústria em prol de algo mais simples, como diagramas de caixas e linhas.

| Mapas do projeto C4

“O modelo C4 foi criado como uma forma de ajudar as equipes de desenvolvimento de software a descrever e comunicar a arquitetura de software, tanto durante sessões de design iniciais quanto ao documentar retrospectivamente uma base de código existente. É uma maneira de criar mapas do seu projeto, em vários níveis de detalhe, da mesma forma que você usaria algo como o Google Maps para ampliar e reduzir uma área em que você está interessado.”

Utilizando a analogia de um zoom em um mapa no Google Maps, podemos acompanhar as diferentes camadas de um projeto. Desde a camada mais superficial (1), que define o contexto do projeto, até a camada (4) que detalha o código implementado do projeto.

Sendo assim, com base numa abordagem diagramática, é possível separar o projeto em diferentes camadas de abstração, capazes de gerar uma comunicação intuitiva e clara para as diferentes partes interessadas em um projeto. Entregando um detalhamento intuitivo para a área de negócios e um detalhamento mais completo para a área de tecnologia. 

| Mas por que se chama modelo C4?

Como citado anteriormente, a base do modelo C4 está em sua estrutura de camadas de abstração, nesse caso, é possível destrinchar o projeto em 4 camadas diferentes do nível mais abstrato ao menos abstrato. Sendo eles: Contexto, Container, Componente e Código. 

Essas 4 camadas são responsáveis por descrever diferentes níveis de detalhamento do projeto. Do menos detalhado ao mais detalhado.

E o ponto focal dessa separação em camadas é garantir a democratização de uma linguagem arquitetural ampla e menos complexa, afinal, cada camada atende níveis técnicos diferentes de tecnologia. Enquanto a camada de Contexto, por exemplo, oferece insights mais gerais sobre as regras de negócio do projeto, a camada de código busca ter uma abordagem mais técnica por meio da utilização de diagramas UML. 

| Os níveis (camadas) do modelo C4

• Nível de Contexto 

O nível de contexto na documentação C4 refere-se à camada mais abstrata do modelo, onde você representa o sistema como um todo e mostra como ele interage com entidades externas. No contexto de um diagrama C4, o nível de contexto mostra o sistema que está sendo desenvolvido e destaca suas relações com usuários, outros sistemas ou serviços externos. Este nível proporciona uma visão de alto nível do sistema, mostrando suas fronteiras e como ele se conecta ao ambiente ao seu redor.

Ao criar um diagrama de contexto no modelo C4, você geralmente representa o sistema central (como um retângulo) e identifica as partes interessadas (como usuários ou sistemas externos) ao seu redor. Este diagrama ajuda a fornecer uma compreensão inicial e fácil de entender da arquitetura do sistema, antes de se aprofundar em camadas mais detalhadas, como contêineres, componentes e classes.

Em resumo, o nível de contexto na documentação C4 é fundamental para estabelecer a visão geral do sistema, mostrando suas relações com o mundo exterior e proporcionando um ponto de partida para discussões mais detalhadas sobre a arquitetura do software.

• Nível de Container

Na documentação C4, o nível de contêiner (Container Level) é o segundo nível de abstração após o nível de contexto. Enquanto o nível de contexto mostra uma visão geral do sistema e suas interações com entidades externas, o nível de contêiner se aprofunda um pouco mais, focando nos principais componentes e serviços do sistema.

No nível de contêiner, você identifica e representa as diferentes partes do sistema que processam e armazenam dados. Um contêiner pode ser uma aplicação web, um serviço da web, um banco de dados, um sistema de filas, entre outros. Em resumo, um contêiner é algo que executa código ou armazena dados.

Em resumo, o nível de contêiner na documentação C4 ajuda a entender a estrutura interna do sistema, fornecendo uma visão detalhada dos principais componentes e serviços que compõem a aplicação. Ele fica entre o nível de contexto e o nível de componente, proporcionando um equilíbrio entre uma visão de alto nível e uma visão extremamente detalhada.

• Nível de Componente
  

No contexto da documentação C4, o nível de componente é o terceiro nível de abstração, após o nível de contexto e o nível de contêiner. No nível de componente, você se aprofunda ainda mais na arquitetura do sistema, identificando e descrevendo os principais componentes do software e suas interações internas.

Os componentes, neste contexto, são partes do sistema que contêm classes ou módulos específicos com funcionalidades bem definidas e isoladas. Por exemplo, em um sistema de Internet Banking, um componente pode ser responsável por processar pagamentos, enquanto outro componente pode lidar com a autenticação dos usuários. Cada componente representa uma parte significativa da lógica de negócios do sistema.

Ao criar um diagrama de componente no modelo C4, você mostra os componentes do sistema e como eles interagem uns com os outros. Você pode representar as dependências entre os componentes, indicando quais componentes usam ou são usados por outros. Isso ajuda a entender como o sistema é organizado internamente e como as diferentes partes colaboram para atender aos requisitos de negócios.

• Nível de Código

O nível de código na documentação C4 refere-se ao nível mais detalhado de abstração, indo além dos níveis de contexto, contêiner e componente. No nível de código, você está olhando diretamente para as classes, interfaces, métodos e estruturas de dados que formam o código fonte do sistema.

Ao criar documentação no nível de código usando o modelo C4, você está detalhando a implementação real do software. Isso pode incluir diagramas de classes, diagramas de sequência, diagramas de pacotes e outros artefatos de UML (ou outras representações visuais) que mostram como o código é estruturado, como as classes se relacionam e como as diferentes partes do código interagem umas com as outras.

| Diagram as code

• Structurizr DSL e C4-PlantUML

Structurizr DSL consiste em uma ferramenta que permite aos desenvolvedores descrever arquiteturas de software usando código. Ela faz parte do ecossistema Structurizr, uma plataforma para visualização, documentação e colaboração em arquiteturas de software. Com a Structurizr DSL, os desenvolvedores podem criar modelos arquiteturais usando uma linguagem específica de domínio (DSL) que representa sistemas, contêineres, componentes, pessoas e interações entre eles.
C4-PlantUML é uma extensão do PlantUML, e também uma ferramenta popular de criação de diagramas UML usando texto. O C4-PlantUML utiliza a sintaxe PlantUML para representar o modelo C4, um modelo de abstração de arquitetura que divide a arquitetura em Contexto, Contêineres, Componentes e Códigos

| Vantagens e desvantagens do modelo C4

Vantagens do C4

Simplicidade e Clareza: O modelo C4 oferece uma maneira simples e intuitiva de visualizar a arquitetura de software em diferentes níveis de abstração, tornando-o fácil de entender para uma variedade de partes interessadas.

Escalabilidade: Ele pode ser escalado de diagramas de contexto de alto nível para detalhes de componentes e código, permitindo uma visão abrangente do sistema.

Comunicação Eficaz: Ajuda na comunicação eficaz entre membros da equipe de desenvolvimento, arquitetos de software, partes interessadas técnicas e não técnicas, fornecendo uma linguagem comum para discutir a arquitetura.

Foco na Arquitetura: Concentra-se em aspectos arquiteturais cruciais, como contextos, contêineres e componentes, ajudando a evitar detalhes desnecessários e manter o foco na estrutura geral do sistema.

Documentação Legível: Gera documentação visualmente legível e compreensível, que pode ser usada para treinamento, revisões de código e manutenção do sistema.

Desvantagens do C4

Limitado para Grandes Sistemas: Sistemas pequenos e simples, o modelo C4 pode parecer excessivo e pode adicionar complexidade desnecessária à documentação.

Curva de Aprendizado: Equipes não familiarizadas com o modelo, pode haver uma curva de aprendizado inicial para entender completamente os conceitos e os detalhes de implementação do C4.

Manutenção da Documentação: À medida que o sistema evolui, a manutenção da documentação C4 para refletir as mudanças no sistema pode ser desafiadora se não for feita de forma regular.

Nível de Detalhe Intermediário: Para alguns casos, o nível de detalhe proporcionado pelo modelo C4 pode não ser suficiente para certas análises de arquitetura profundas, onde uma visão mais detalhada do código é necessária.

| Conclusão

O modelo de documentação C4 oferece uma abordagem clara e eficaz para visualizar e documentar arquiteturas de software. Ele se destaca por sua simplicidade, escalabilidade e clareza, permitindo que as equipes de desenvolvimento comuniquem efetivamente a estrutura de seus sistemas para uma variedade de públicos, desde partes interessadas não técnicas até desenvolvedores e arquitetos de software.

No entanto, é importante notar que, como qualquer ferramenta de documentação, o sucesso do C4 depende de como é implementado e integrado nas práticas de desenvolvimento de uma equipe. Uma aplicação cuidadosa e consistente do modelo C4 pode levar a uma documentação arquitetônica valiosa, melhorando a colaboração, a tomada de decisões informadas e, finalmente, a qualidade do software desenvolvido.