O Chatbot de IA do Visual Paradigm torna possível criar um Diagrama de Contexto de Sistema C4 a partir de uma descrição em linguagem natural de um aplicativo, seus usuários e os sistemas externos com os quais ele interage. No entanto, um diagrama gerado por IA é mais útil quando permanece editável e mantível após a geração.

Este guia demonstra um fluxo de trabalho completo para gerar um diagrama de contexto de uma Plataforma de Entrega de Alimentos usando C4-PlantUML. Você aprenderá como transitar de um diagrama gerado por IA para código PlantUML editável, refinar o modelo no VPasCode e continuar editando-o visualmente no Visual Paradigm Online. A abordagem combina a velocidade da modelagem assistida por IA com a flexibilidade do diagrama como código e a conveniência de um editor de diagramas gráficos.

O Visual Paradigm oferece um fluxo de trabalho prático para transformar uma descrição de arquitetura em linguagem natural em um Diagrama de Contexto C4 editável:

1. Descreva o sistema no Chatbot de IA do Visual Paradigm.

   

2. Gerar e revisar o Diagrama de Contexto de Sistema C4.

3. Abra o resultado no VPasCode como C4-PlantUML.

   

4. Modifique o diagrama editando o código PlantUML.

   

5. Opcionalmente, envie o resultado para o Visual Paradigm Online.

   

6. Modifique o diagrama visualmente usando o editor de diagramas de arrastar e soltar.

Isso oferece dois caminhos de edição:

• Edição baseada em código:VPasCode e C4-PlantUML

• Edição baseada em interface gráfica:Editor de Diagramas do Visual Paradigm Online

O Chatbot de IA do Visual Paradigm suporta diagramas de Contexto de Sistema, Contêiner, Componente e Implantação C4. Ele também pode refinar um diagrama gerado por meio de comandos em linguagem natural, como adicionar, remover, renomear ou reconectar elementos.

1. Entenda o Diagrama de Contexto C4

Um Diagrama de Contexto C4 é a visão de mais alto nível de um sistema de software. Ele mostra:

• Osistema de interesse

• Usuários humanos e atores organizacionais

• Sistemas de software externos

• Relacionamentos importantes entre esses elementos

• Uma breve descrição de como cada relacionamento funciona

Normalmente, ele não mostra serviços internos, bancos de dados, classes, APIs ou detalhes de infraestrutura. Esses pertencem a diagramas C4 de níveis inferiores.

Por exemplo, um diagrama de contexto para uma plataforma de entrega de alimentos online pode conter:

• Cliente

• Gerente do Restaurante

• Entregador

• Provedor de Pagamento

• Serviço de Mapa e Geolocalização

• Serviço de Notificação

• Plataforma de Entrega de Comida

O sistema central deve permanecer o foco visual. Pessoas e sistemas externos devem ser posicionados ao seu redor.

2. Prepare um Bom Prompt para IA

A qualidade do diagrama gerado depende fortemente da descrição da arquitetura fornecida ao chatbot.

Um prompt útil especifica:

• O nome do sistema

• O propósito do sistema

• As pessoas que o utilizam

• Sistemas externos com os quais ele se comunica

• As relações entre eles

• O nível desejado do diagrama C4

• O formato de saída desejado

• O que não deve ser incluído

Exemplo de prompt

Crie um Diagrama de Contexto de Sistema C4 para uma plataforma online de entrega de comida.

Sistema de interesse:
Plataforma de Entrega de Comida — permite que os clientes naveguem pelos restaurantes, façam pedidos, realizem pagamentos e acompanhem as entregas.

Pessoas:
1. Cliente — navega pelos restaurantes, faz pedidos, paga e acompanha a entrega.
2. Gerente do Restaurante — gerencia os menus, aceita pedidos e atualiza o status do pedido.
3. Entregador — aceita trabalhos de entrega e atualiza o progresso da entrega.
4. Administrador de Operações — monitora a atividade da plataforma e resolve questões de suporte.

Sistemas externos:
1. Provedor de Pagamento — autoriza e captura os pagamentos dos clientes.
2. Serviço de Mapa e Geolocalização — fornece endereços, rotas e locais de entrega.
3. Serviço de Notificação — envia e-mails, SMS e notificações push.

Relações:
- O Cliente utiliza a Plataforma de Entrega de Comida para navegar pelos restaurantes, fazer pedidos, realizar pagamentos e acompanhar as entregas.
- O Gerente do Restaurante utiliza a Plataforma de Entrega de Comida para gerenciar menus e processar pedidos.
- O Entregador utiliza a Plataforma de Entrega de Comida para receber trabalhos de entrega e atualizar o status da entrega.
- O Administrador de Operações utiliza a Plataforma de Entrega de Comida para monitorar as operações e resolver problemas.
- A Plataforma de Entrega de Comida utiliza o Provedor de Pagamento para autorizar e capturar pagamentos.
- A Plataforma de Entrega de Comida utiliza o Serviço de Mapa e Geolocalização para calcular rotas e rastrear locais.
- A Plataforma de Entrega de Comida utiliza o Serviço de Notificação para enviar notificações.

Gere um Diagrama de Contexto de Sistema C4 limpo. Não mostre contêineres internos, componentes, bancos de dados, classes ou infraestrutura de implantação. Use rótulos de relação concisos.

A instrução explícita para excluir detalhes internos é importante. Sem ela, um gerador de IA pode produzir um diagrama que mistura informações de nível de contexto e de nível de contêiner.

3. Gere o Diagrama no Chatbot de IA do Visual Paradigm

Abra o Chatbot de IA do Visual Paradigm e inicie uma nova conversa ou sessão de geração de diagrama.

Dependendo da interface e da edição da assinatura, o chatbot pode fornecer um seletor de tipo de diagrama. Selecione:

• Modelo C4

• Diagrama de Contexto de Sistema

Em seguida, insira o prompt.

O fluxo de trabalho geral do chatbot do Visual Paradigm é:

1. Descreva o diagrama.

2. Deixe a IA gerar o modelo inicial.

3. Revise o resultado.

4. Refine-o com comandos em linguagem natural.

5. Exporte ou continue editando em outra ferramenta do Visual Paradigm.

Revise o primeiro resultado

Verifique se o diagrama contém:

• Exatamente um sistema central

• Todas as pessoas necessárias

• Todos os sistemas externos relevantes

• Direções de relacionamento corretas

• Descrições de relacionamento concisas

• Nenhum serviço interno ou banco de dados desnecessário

• Nomenclatura consistente

• Layout legível

Um diagrama gerado é um ponto de partida, não um substituto para a revisão de arquitetura.

4. Refine o Diagrama por meio de Conversa

O chatbot pode modificar o diagrama usando linguagem comum.

Adicionar um elemento

Adicionar um Agente de Suporte ao Cliente que utiliza a Plataforma de Entrega de Alimentos para investigar problemas dos clientes e processar reembolsos.

Adicionar um sistema externo

Adicionar um Serviço Externo de Detecção de Fraudes utilizado pela Plataforma de Entrega de Alimentos para avaliar pagamentos suspeitos.

Renomear um elemento

Renomear “Serviço de Notificação” para “Serviço de Mensagens e Notificação”.

Alterar um relacionamento

Alterar o relacionamento entre o Entregador e a Plataforma de Entrega de Alimentos para:
“Recebe atribuições de entrega e envia atualizações de status de entrega.”

Remover um elemento

Remover o Administrador de Operações do diagrama.

Melhorar o layout

Reorganizar o diagrama de modo que as pessoas apareçam no topo, os sistemas externos apareçam na parte inferior e a Plataforma de Entrega de Alimentos permaneça centralizada.

Simplificar o diagrama

Simplifique isto em um Diagrama de Contexto de Sistema C4 estrito. Remova detalhes de implementação, bancos de dados, APIs, microsserviços e componentes internos.

Solicitar uma revisão de consistência

Revise o diagramo quanto a relacionamentos ausentes, rótulos ambíguos, sistemas duplicados e elementos que não pertencem a um Diagrama de Contexto C4.

A documentação do Chatbot de IA descreve esta abordagem iterativa, incluindo comandos para adicionar gateways de pagamento, renomear elementos, alterar relacionamentos e refatorar diagramas.

Parte 1: Abra o Diagrama no VPasCode para Edição de Código

5. Use “Abrir no VPasCode” ou “Editar no VPasCode”

Após gerar e refinar o diagrama, use a ação rotulada de forma semelhante a:

• Abrir no VPasCode

• Editar no VPasCode

• Abrir Código

• Gerar Código para Edição

O rótulo exato do botão pode variar dependendo da interface atual.

Isso transfere o código do diagrama para o VPasCode, onde você pode editar o diagrama como texto enquanto visualiza uma prévia renderizada em tempo real. A Visual Paradigm descreve o VPasCode como um editor de diagramas como código baseado em navegador que suporta PlantUML, modelos C4, Mermaid, Graphviz e outros formatos de sintaxe.

O código gerado deve usar C4-PlantUML, tipicamente com:

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
...
@enduml

O script gerado pode usar uma URL de inclusão diferente ou uma versão de biblioteca suportada internamente. Preserve a inclusão gerada pelo VPasCode, a menos que tenha um motivo específico para alterá-la.

6. Entenda a Estrutura C4-PlantUML

Um diagrama de contexto C4-PlantUML típico contém estas partes:

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

LAYOUT_LEFT_RIGHT()

Person(customer, "Cliente", "Realiza pedidos de comida e rastreia entregas.")
System(platform, "Plataforma de Entrega de Comida", "Permite que os clientes façam pedidos de comida e rastreiem entregas.")
System_Ext(payment, "Provedor de Pagamento", "Autoriza e captura pagamentos.")

Rel(customer, platform, "Realiza pedidos e rastreia entregas")
Rel(platform, payment, "Autoriza e captura pagamentos")

@enduml

Tipos principais de elementos

O primeiro argumento é o identificador interno. O segundo é o nome de exibição. O terceiro é a descrição.

7. Editar o Diagrama no VPasCode

O VPasCode normalmente exibe:

• O código-fonte em um painel de editor

• O diagrama renderizado em um painel de visualização

• Ações para exportar, compartilhar, copiar ou abrir o resultado em outro produto Visual Paradigm

O VPasCode fornece renderização em tempo real e suporta edição direta de código. Ele também pode detectar formatos de diagrama suportados quando o código é colado no editor.

Exemplo: código C4-PlantUML aprimorado

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml

title Plataforma de Entrega de Comida — Contexto do Sistema

LAYOUT_LEFT_RIGHT()
SHOW_LEGEND()

Person(customer, "Cliente",
  "Navega em restaurantes, faz pedidos, paga e acompanha entregas.")

Person(restaurantManager, "Gerente de Restaurante",
  "Gerencia cardápios, aceita pedidos e atualiza o status dos pedidos.")

Person(deliveryDriver, "Entregador",
  "Recebe atribuições de entrega e atualiza o progresso da entrega.")

Person(operationsAdmin, "Administrador de Operações",
  "Monitora as operações da plataforma e resolve questões de suporte.")

System(platform, "Plataforma de Entrega de Comida",
  "Permite pedidos de comida, pagamentos, gestão de restaurantes e rastreamento de entregas.")

System_Ext(paymentProvider, "Provedor de Pagamento",
  "Autoriza e captura pagamentos dos clientes.")

System_Ext(mapService, "Serviço de Mapas e Geolocalização",
  "Fornece endereços, rotas e dados de localização.")

System_Ext(notificationService, "Serviço de Notificações",
  "Envia e-mails, SMS e notificações push.")

Rel(customer, platform,
  "Navega em restaurantes, faz pedidos, paga e acompanha entregas")

Rel(restaurantManager, platform,
  "Gerencia cardápios e processa pedidos de restaurantes")

Rel(deliveryDriver, platform,
  "Recebe tarefas de entrega e submete status de entrega")

Rel(operationsAdmin, platform,
  "Monitora operações e resolve questões de suporte")

Rel(platform, paymentProvider,
  "Autoriza e captura pagamentos")

Rel(platform, mapService,
  "Calcula rotas e rastreia locais de entrega")

Rel(platform, notificationService,
  "Envia notificações de pedido, pagamento e entrega")

@enduml

8. Realizar Alterações Comuns no Nível do Código

Alterar o nome do sistema

System(platform, "Plataforma de Entrega de Refeições",
  "Coordena pedidos de comida e entregas.")

Adicionar uma nova pessoa

Person(customerSupport, "Agente de Suporte ao Cliente",
  "Investiga questões dos clientes e processa reembolsos.")

Rel(customerSupport, platform,
  "Investiga questões e gerencia reembolsos")

Adicionar um novo sistema externo

System_Ext(fraudService, "Serviço de Detecção de Fraude",
  "Avalia atividades de pagamento suspeitas.")

Rel(platform, fraudService,
  "Verifica transações de pagamento quanto a riscos de fraude")

Alterar a direção da relação

Rel(paymentProvider, platform,
  "Retorna resultados de autorização e liquidação de pagamento")

Use a direção da relação para representar a dependência ou interação principal. Se a direção não for arquiteturamente importante, escolha uma convenção consistente e aplique-a em todo o diagrama.

Alterar layout

C4-PlantUML suporta dicas de layout, como:

LAYOUT_LEFT_RIGHT()

ou:

LAYOUT_TOP_DOWN()

Você também pode influenciar o posicionamento com dicas de direção:

Lay_R(customer, platform)
Lay_D(platform, paymentProvider)

Use dicas de layout com moderação. Muitas restrições manuais podem tornar o diagrama mais difícil de manter.

9. Use a Assistência de IA do VPasCode

Algumas edições do VPasCode fornecem modificação de diagramas assistida por IA e correção de erros de código. A ferramenta pode aceitar instruções como:

Adicione um serviço externo de detecção de fraudes entre a plataforma e o provedor de pagamento.

ou:

Corrija o erro de sintaxe do PlantUML e preserve a estrutura atual do diagrama.

O VPasCode também é documentado como suportando funcionalidades de modificação de diagramas, diagnóstico de erros e tradução impulsionadas por IA, embora a disponibilidade possa depender da edição ou assinatura.

10. Valide o Diagrama PlantUML

Antes de enviar o diagrama para o Visual Paradigm Online, valide tanto a sintaxe quanto a arquitetura.

Lista de verificação de sintaxe

• O script começa com @startuml.

• O script termina com @enduml.

• A biblioteca C4-PlantUML está incluída.

• Cada relacionamento referencia identificadores existentes.

• Os identificadores não contêm espaços ou pontuação que possam quebrar a sintaxe.

• As aspas estão equilibradas.

• As descrições não são excessivamente longas.

• A pré-visualização é renderizada sem erros.

Lista de verificação de modelagem C4

• Há um sistema de interesse claramente identificado.

• Os usuários são modelados como pessoas, não como sistemas de software.

• Aplicações externas são modeladas como sistemas externos.

• Contêineres internos não são incluídos em um diagrama de contexto.

• Relacionamentos descrevem interações significativas.

• O diagrama é compreensível sem ler o código-fonte.

• A terminologia corresponde à documentação de arquitetura do projeto.

Exemplo de um elemento indesejável em um diagrama de contexto

Container(api, "API de Pedidos", "Java", "Processa pedidos")
ContainerDb(database, "Banco de Dados de Pedidos", "PostgreSQL", "Armazena pedidos")

Estes são elementos de nível de contêiner. Eles pertencem a um Diagrama de Contêiner C4, não normalmente a um Diagrama de Contexto do Sistema.

Parte 2: Enviar o Diagrama para o Visual Paradigm Online

11. Use “Editar no VP Online” ou “Editar no Diagrama VP Online”

Após a versão do código estar correta, selecione a ação rotulada de forma semelhante a:

• Editar no VP Online

• Editar no Diagrama VP Online

• Abrir no Online

• Exportar para o VP Online

O rótulo exato pode variar conforme a versão da interface.

O ecossistema do Visual Paradigm foi projetado para mover diagramas gerados do Chatbot de IA para o VPasCode para refinamento em nível de código e, em seguida, para o Visual Paradigm Online para edição tradicional de diagramas.

O Editor de Diagramas Online é útil quando você precisa:

• Mover formas manualmente

• Redimensionar elementos

• Ajustar conectores

• Alterar cores e fontes

• Adicionar notas ou anotações

• Adicionar um título ou legenda

• Aplicar formatação de apresentação

• Alinhar elementos do diagrama com precisão

• Prepare o diagrama para compartilhamento ou exportação

12. Modifique o diagrama usando a interface gráfica do Visual Paradigm Online

Assim que o diagrama abrir no Visual Paradigm Online:

Mover elementos

Arraste pessoas e sistemas externos para uma disposição clara ao redor do sistema central.

Um layout comum é:

• Pessoas à esquerda ou no topo

• Sistema principal no centro

• Sistemas externos à direita ou na parte inferior

Editar texto

Clique duas vezes em um elemento ou selecione seu painel de especificação para modificar:

• Nome

• Descrição

• Estereótipo

• Rótulo de relacionamento

Mantenha os nomes curtos e as descrições informativas.

Editar relacionamentos

Selecione um conector para:

• Alterar sua direção

• Editar o rótulo do relacionamento

• Reconectá-lo a outro elemento

• Ajustar seu roteamento

• Alterar o estilo ou a aparência da linha

Adicionar elementos

Use a paleta do diagrama para adicionar:

• Pessoa

• Pessoa externa

• Sistema

• Sistema externo

• Relacionamento

• Nota

• Fronteira

Adicione apenas elementos que pertencem ao nível de contexto.

Aplicar formatação

Você pode melhorar a legibilidade ajustando:

• Tamanho da fonte

• Cor de preenchimento

• Cor da borda

• Espessura da linha

• Tamanho da forma

• Alinhamento

• Espaçamento

• Roteamento de conectores

Evite usar a cor como a única maneira de comunicar significado. Use também rótulos claros.

13. Layout de Apresentação Recomendado

Um diagrama de contexto limpo pode usar este arranjo:

Para diagramas maiores:

• Mantenha o sistema principal centralizado.

• Agrupar pessoas em um lado.

• Agrupar sistemas de software externos em outro lado.

• Evite cruzar linhas de relacionamento.

• Mantenha os rótulos de relacionamento horizontais, sempre que possível.

• Use rótulos curtos em vez de parágrafos.

• Deixe espaço em branco suficiente ao redor do sistema central.

Parte 3: Escolhendo entre Edição de Código e Edição por GUI

O VPasCode suporta modelos C4 por meio do PlantUML e oferece uma visualização ao vivo, enquanto o Visual Paradigm Online oferece um fluxo de trabalho tradicional de edição de diagramas visuais.

Parte 4: Fluxo de trabalho recomendado de ponta a ponta

Fluxo de trabalho rápido

1. Abra o Chatbot de IA do Visual Paradigm.

2. Escolha o Diagrama de Contexto do Sistema C4.

3. Descreva o sistema, os usuários e os sistemas externos.

4. Gere o diagrama.

5. Peça ao chatbot para remover os detalhes internos de implementação.

6. Revise nomes, relacionamentos e escopo.

7. Selecione Abrir no VPasCode.

8. Edite a fonte C4-PlantUML.

9. Renderize e valide o resultado.

10. Selecione Editar no VP Online.

11. Refinar o layout e a aparência usando a interface gráfica.

12. Exportar ou compartilhar o diagrama final.

Divisão recomendada de responsabilidades

Use o Chatbot de IA para:

• Criar o primeiro rascunho

• Explorar alternativas de arquitetura

• Adicionar ou remover participantes

• Reformular descrições de relacionamentos

• Revisar o diagrama quanto a omissões

Use VPasCode para:

• Renomear muitos elementos

• Reutilizar código de diagrama

• Aplicar sintaxe consistente

• Gerenciar código em controle de versão

• Realizar alterações estruturais repetíveis

• Corrigir diretivas de layout

• Produzir uma fonte de verdade baseada em texto

Use Visual Paradigm Online para:

• Posicionamento visual final

• Formatação de apresentação

• Ajuste manual de conectores

• Adicionar notas e anotações

• Preparando um diagrama para as partes interessadas

Parte 5: Exemplo de conversa de refinamento

Solicitação inicial

Crie um Diagrama de Contexto de Sistema C4 para uma plataforma de entrega de alimentos.

Refinamento 1

Adicione Cliente, Gerente de Restaurante, Entregador e Administrador de Operações como pessoas.

Refinamento 2

Adicione Provedor de Pagamento, Serviço de Mapa e Geolocalização, e Serviço de Notificação como sistemas externos.

Refinamento 3

Remova todos os bancos de dados, APIs, microsserviços, contêineres e detalhes de implementação. Isso deve permanecer como um Diagrama de Contexto de Sistema C4 de Nível 1.

Refinamento 4

Reescreva todos os rótulos de relacionamento como frases verbais concisas e mantenha-os com menos de 10 palavras, sempre que possível.

Refinamento 5

Revise o diagrama quanto a relacionamentos ausentes e terminologia inconsistente. Mantenha “Plataforma de Entrega de Alimentos” como o único sistema de interesse.

Refinamento 6

Gere o diagrama como C4-PlantUML e torne-o disponível para edição no VPasCode.

Parte 6: Solução de problemas

O diagrama contém muitos detalhes

Pergunte:

Simplifique isso para um Diagrama de Contexto de Sistema C4 estrito. Remova contêineres, componentes, bancos de dados, APIs e nomes de tecnologias.

O diagrama tem muitas linhas cruzadas

No VPasCode:

• Tente LAYOUT_LEFT_RIGHT() ou LAYOUT_TOP_DOWN().

• Adicione limitadas Lay_ diretrizes.

• Encurte os rótulos das relações.

• Reduza o número de relações exibidas.

• Mova a versão final para o VP Online para posicionamento manual.

A pré-visualização do PlantUML mostra um erro

Verifique:

• A biblioteca C4 inclui

• Vírgulas ausentes

• Parênteses não fechados

• Identificadores com erro de ortografia

• Relações que referenciam elementos não definidos

• Aspas desequilibradas

• Nomes de elementos incorretos

Uma relação deve referenciar identificadores que já foram declarados, por exemplo:

Person(customer, "Cliente", "Realiza pedidos")
System(platform, "Plataforma de Entrega de Comida", "Processa pedidos")

Rel(customer, platform, "Realiza pedidos")

A versão da interface gráfica difere da versão do código

Trate as duas versões como representações de edição separadas após a conversão. Tome uma decisão deliberada sobre qual delas é a fonte da verdade:

• Use VPasCode como a fonte da verdade se o diagrama for mantido como código.

• Use Visual Paradigm Online como a fonte da verdade se as partes interessadas ajustarem visualmente com frequência.

Evite fazer alterações não relacionadas em ambos os locais sem sincronizá-los.

O diagrama gerado usa o nível C4 incorreto

Pergunte ao chatbot:

Regenere isto apenas como um Diagrama de Contexto de Sistema C4. Mostre pessoas, o sistema de interesse e sistemas de software externos. Não mostre contêineres ou componentes.

Lista de Verificação Final de Qualidade

Antes de publicar o diagrama, confirme que:

• O diagrama tem um título claro.

• O sistema de interesse é óbvio.

• Pessoas e sistemas externos estão corretamente classificados.

• As relações têm rótulos significativos.

• Nenhum detalhe de implementação interna vazou para a visão de contexto.

• Os nomes usam terminologia consistente.

• O diagrama é legível no zoom normal.

• As linhas de relação não obscurecem formas ou rótulos.

• A fonte PlantUML é renderizada com sucesso.

• A versão VP Online corresponde à arquitetura aprovada.

• O diagrama final foi revisado por alguém familiarizado com o sistema.

O fluxo de trabalho mais eficaz é usar o Chatbot de IA para modelagem rápida, VPasCode para edição precisa e repetível de C4-PlantUML, e Visual Paradigm Online para refinamento visual final. Isso combina geração conversacional, manutenibilidade de diagrama como código e edição de apresentação baseada em GUI em um único processo.

This post is also available in Deutsch, English, Español, Français, English, Bahasa Indonesia, 日本語, Polski and Ру́сский.