Czat AI Visual Paradigm umożliwia tworzenie diagramu kontekstowego systemu C4 na podstawie opisu w języku naturalnym aplikacji, jej użytkowników oraz zewnętrznych systemów, z którymi ona współpracuje. Jednak diagram wygenerowany przez AI jest najbardziej przydatny, gdy pozostaje edytowalny i łatwy do utrzymania po wygenerowaniu.

Ten przewodnik przedstawia pełny proces od początku do końca generowania diagramu kontekstowego platformy dostaw żywności przy użyciu C4-PlantUML. Nauczysz się, jak przejść od diagramu wygenerowanego przez AI do edytowalnego kodu PlantUML, udoskonalić model w VPasCode i kontynuować jego edycję wizualnie w Visual Paradigm Online. Podejście to łączy szybkość modelowania wspieranego przez AI z elastycznością diagramu jako kodu oraz wygodą graficznego edytora diagramów.

Visual Paradigm oferuje praktyczny proces przekształcania opisu architektury w języku naturalnym w edytowalny diagram kontekstowy C4:

1. Opisz system w czacie AI Visual Paradigm.

   

2. Wygeneruj i sprawdź diagram kontekstowy systemu C4.

3. Otwórz wynik w VPasCode jako C4-PlantUML.

   

4. Zmień diagram, edytując kod PlantUML.

   

5. Opcjonalnie wyślij wynik do Visual Paradigm Online.

   

6. Zmień diagram wizualnie za pomocą edytora diagramów typu przeciągnij i upuść.

Daje to dwie ścieżki edycji:

• Edycja oparta na kodzie: VPasCode i C4-PlantUML

• Edycja oparta na interfejsie graficznym (GUI): Edytor diagramów Visual Paradigm Online

Czat AI Visual Paradigm obsługuje diagramy kontekstu systemu, kontenera, komponentu i wdrożenia C4. Może również udoskonalać wygenerowany diagram za pomocą poleceń w języku naturalnym, takich jak dodawanie, usuwanie, zmiana nazw lub ponowne łączenie elementów.

1. Zrozumienie diagramu kontekstowego C4

Diagram kontekstowy C4 to widok najwyższego poziomu systemu oprogramowania. Pokazuje:

• Systemsystem zainteresowania

• Ludzie użytkownicy oraz aktorzy organizacyjni

• Zewnętrzne systemy oprogramowania

• Ważne relacje między tymi elementami

• Krótki opis działania każdej relacji

Zazwyczaj nie pokazuje wewnętrznych usług, baz danych, klas, interfejsów API ani szczegółów infrastruktury. Te elementy należą do diagramów C4 niższego poziomu.

Na przykład diagram kontekstowy dla internetowej platformy dostaw żywności może zawierać:

• Klient

• Kierownik restauracji

• Kierowca dostaw

• Dostawca płatności

• Usługa mapowania i geolokalizacji

• Usługa powiadomień

• Platforma dostaw żywności

Centralny system powinien pozostać głównym punktem skupienia wzroku. Osoby zewnętrzne i systemy powinny być umieszczone wokół niego.

2. Przygotuj dobre polecenie dla sztucznej inteligencji

Jakość wygenerowanego diagramu zależy w dużej mierze od opisu architektury dostarczonego do czatu.

Przydatne polecenie określa:

• Nazwa systemu

• Cel systemu

• Osoby, które z niego korzystają

• Zewnętrzne systemy, z którymi się komunikuje

• Relacje między nimi

• Poziom diagramu C4, jaki jest pożądany

• Pożądany format wyjściowy

• Czego nie należy uwzględniać

Przykładowe polecenie

Stwórz diagram kontekstu systemu C4 dla internetowej platformy dostaw żywności.

System zainteresowania:
Platforma dostaw żywności — umożliwia klientom przeglądanie restauracji, składanie zamówień, dokonywanie płatności i śledzenie dostaw.

Osoby:
1. Klient — przegląda restauracje, składa zamówienia, płaci i śledzi dostawy.
2. Menadżer restauracji — zarządza menu, przyjmuje zamówienia i aktualizuje status zamówienia.
3. Kierowca dostawczy — przyjmuje zlecenia dostaw i aktualizuje postępy dostaw.
4. Administrator operacyjny — monitoruje aktywność platformy i rozwiązuje problemy z obsługą klienta.

Zewnętrzne systemy:
1. Dostawca płatności — autoryzuje i pobiera płatności klientów.
2. Usługa mapowania i geolokalizacji — dostarcza adresy, trasy i lokalizacje dostaw.
3. Usługa powiadomień — wysyła wiadomości e-mail, SMS i powiadomienia push.

Relacje:
- Klient korzysta z Platformy dostaw żywności, aby przeglądać restauracje, składać zamówienia, dokonywać płatności i śledzić dostawy.
- Menadżer restauracji korzysta z Platformy dostaw żywności, aby zarządzać menu i przetwarzać zamówienia.
- Kierowca dostawczy korzysta z Platformy dostaw żywności, aby otrzymywać zlecenia dostaw i aktualizować status dostaw.
- Administrator operacyjny korzysta z Platformy dostaw żywności, aby monitorować operacje i rozwiązywać problemy.
- Platforma dostaw żywności korzysta z Dostawcy płatności, aby autoryzować i pobierać płatności.
- Platforma dostaw żywności korzysta z Usługi mapowania i geolokalizacji, aby obliczać trasy i śledzić lokalizacje.
- Platforma dostaw żywności korzysta z Usługi powiadomień, aby wysyłać powiadomienia.

Wygeneruj czysty diagram kontekstu systemu C4. Nie pokazuj wewnętrznych kontenerów, komponentów, baz danych, klas ani infrastruktury wdrożenia. Używaj zwięzłych etykiet relacji.

Jawne polecenie wykluczenia szczegółów wewnętrznych jest ważne. Bez niego generator AI może wygenerować diagram mieszający informacje na poziomie kontekstu i poziomie kontenera.

3. Wygeneruj diagram w czacie AI Visual Paradigm

Otwórz czat AI Visual Paradigm i rozpocznij nową rozmowę lub sesję generowania diagramu.

W zależności od interfejsu i wersji subskrypcji czat może oferować selektor typu diagramu. Wybierz:

• Model C4

• Diagram kontekstu systemu

Następnie wprowadź polecenie.

Ogólny przepływ pracy czatu Visual Paradigm wygląda następująco:

1. Opisz diagram.

2. Pozwól AI wygenerować wstępny model.

3. Przejrzyj wynik.

4. Ulepsz go za pomocą poleceń w języku naturalnym.

5. Eksportuj lub kontynuuj edycję w innym narzędziu Visual Paradigm.

Przejrzyj pierwszy wynik

Sprawdź, czy diagram zawiera:

• Równie dokładnie jeden system centralny

• Wszyscy wymagani ludzie

• Wszystkie istotne systemy zewnętrzne

• Poprawne kierunki relacji

• Zwięzłe opisy relacji

• Brak niepotrzebnych usług wewnętrznych lub baz danych

• Spójna nazewnictwo

• Czytelny układ

Wygenerowany diagram jest punktem wyjścia, a nie substytutem przeglądu architektury.

4. Dopracuj diagram poprzez rozmowę

Chatbot może modyfikować diagram, używając zwykłego języka.

Dodaj element

Dodaj Agenta Obsługi Klienta, który wykorzystuje Platformę Dostaw Żywności do badania problemów klientów i przetwarzania zwrotów pieniędzy.

Dodaj system zewnętrzny

Dodaj zewnętrzny Usługę Wykrywania Nadużyć wykorzystywaną przez Platformę Dostaw Żywności do oceny podejrzanych płatności.

Zmień nazwę elementu

Zmień nazwę „Usługi Powiadomień” na „Usługę Wiadomości i Powiadomień”.

Zmień relację

Zmień relację między Kierowcą Dostawczym a Platformą Dostaw Żywności na:
„Otrzymuje zlecenia dostaw i przesyła aktualizacje statusu dostaw”.

Usuń element

Usuń Administratora Operacji z diagramu.

Popraw układ

Przestaw diagram tak, aby ludzie pojawiali się na górze, systemy zewnętrzne na dole, a Platforma Dostaw Żywności pozostała wyśrodkowana.

Uprość diagram

Uprość to do ścisłego diagramu kontekstu systemu C4. Usuń szczegóły implementacji, bazy danych, API, mikrousługi i komponenty wewnętrzne.

Zażądaj przeglądu spójności

Przejrzyj diagram pod kątem brakujących relacji, niejednoznacznych etykiet, zduplikowanych systemów oraz elementów, które nie należą do diagramu kontekstu C4.

Dokumentacja czatbota AI opisuje to podejście iteracyjne, w tym polecenia dodawania bram płatności, zmiany nazw elementów, modyfikacji relacji oraz refaktoryzacji diagramów.

Część 1: Otwórz diagram w VPasCode do edycji kodu

5. Użyj opcji „Otwórz w VPasCode” lub „Edytuj w VPasCode”

Po wygenerowaniu i dopracowaniu diagramu użyj akcji oznaczonej podobnie do:

• Otwórz w VPasCode

• Edytuj w VPasCode

• Otwórz kod

• Generuj kod do edycji

Dokładna etykieta przycisku może się różnić w zależności od aktualnego interfejsu.

To przenosi kod diagramu do VPasCode, gdzie możesz edytować diagram jako tekst, jednocześnie przeglądając podgląd renderowany na żywo. Visual Paradigm opisuje VPasCode jako przeglądarkowy edytor diagramów typu „diagram jako kod”, obsługujący PlantUML, modele C4, Mermaid, Graphviz i inne formaty składni.

Wygenerowany kod powinien używać C4-PlantUML, zazwyczaj z:

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

Wygenerowany skrypt może użyć innego adresu URL do dołączania lub wewnętrznie obsługiwanej wersji biblioteki. Zachowaj dołączenie wygenerowane przez VPasCode, chyba że masz konkretny powód, aby je zmienić.

6. Zrozum strukturę C4-PlantUML

Typowy diagram kontekstowy C4-PlantUML zawiera następujące części:

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

LAYOUT_LEFT_RIGHT()

Person(customer, "Klient", "Zamawia posiłki i śledzi dostawy.")
System(platform, "Platforma dostaw żywności", "Pozwala klientom zamawiać posiłki i śledzić dostawy.")
System_Ext(payment, "Dostawca płatności", "Autoryzuje i pobiera płatności.")

Rel(customer, platform, "Zamawia posiłki i śledzi dostawy")
Rel(platform, payment, "Autoryzuje i pobiera płatności")

@enduml

Główne typy elementów

Pierwszy argument to wewnętrzny identyfikator. Drugi to nazwa wyświetlana. Trzeci to opis.

7. Edytuj diagram w VPasCode

VPasCode zazwyczaj wyświetla:

• Kod źródłowy w oknie edytora

• Wyrenderowany diagram w oknie podglądu

• Akcje eksportowania, udostępniania, kopiowania lub otwierania wyniku w innym produkcie Visual Paradigm

VPasCode zapewnia renderowanie na żywo i obsługuje bezpośrednią edycję kodu. Może również wykrywać obsługiwane formaty diagramów, gdy kod zostanie wklejony do edytora.

Przykład: ulepszony kod C4-PlantUML

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

title Platform Dostaw Jedzenia — Kontekst Systemu

LAYOUT_LEFT_RIGHT()
SHOW_LEGEND()

Person(customer, "Klient",
  "Przegląda restauracje, składa zamówienia, płaci i śledzi dostawy.")

Person(restaurantManager, "Menedżer Restauracji",
  "Zarządza menu, przyjmuje zamówienia i aktualizuje status zamówień.")

Person(deliveryDriver, "Kierowca Dostawczy",
  "Otrzymuje zlecenia dostaw i aktualizuje postępy dostaw.")

Person(operationsAdmin, "Administrator Operacyjny",
  "Monitoruje działanie platformy i rozwiązuje problemy z obsługą klienta.")

System(platform, "Platforma Dostaw Jedzenia",
  "Umożliwia zamawianie jedzenia, płatności, zarządzanie restauracjami i śledzenie dostaw.")

System_Ext(paymentProvider, "Dostawca Płatności",
  "Autoryzuje i pobiera płatności klientów.")

System_Ext(mapService, "Usługa Map i Geolokalizacji",
  "Dostarcza adresy, trasy i dane lokalizacyjne.")

System_Ext(notificationService, "Usługa Powiadomień",
  "Wysyła powiadomienia e-mail, SMS i push.")

Rel(customer, platform,
  "Przegląda restauracje, składa zamówienia, płaci i śledzi dostawy")

Rel(restaurantManager, platform,
  "Zarządza menu i przetwarza zamówienia restauracyjne")

Rel(deliveryDriver, platform,
  "Otrzymuje zlecenia dostaw i zgłasza status dostaw")

Rel(operationsAdmin, platform,
  "Monitoruje operacje i rozwiązuje problemy z obsługą klienta")

Rel(platform, paymentProvider,
  "Autoryzuje i pobiera płatności")

Rel(platform, mapService,
  "Oblicza trasy i śledzi lokalizacje dostaw")

Rel(platform, notificationService,
  "Wysyła powiadomienia o zamówieniach, płatnościach i dostawach")

@enduml

8. Wprowadź wspólne zmiany na poziomie kodu

Zmień nazwę systemu

System(platform, "Platforma Dostaw Jedzenia",
  "Koordynuje zamawianie i dostawę jedzenia.")

Dodaj nową osobę

Person(customerSupport, "Agent Obsługi Klienta",
  "Rozpatruje problemy klientów i przetwarza zwroty środków.")

Rel(customerSupport, platform,
  "Rozpatruje problemy i obsługuje zwroty środków")

Dodaj nowy zewnętrzny system

System_Ext(fraudService, "Usługa Wykrywania Nadużyć",
  "Ocenia podejrzane aktywności płatnicze.")

Rel(platform, fraudService,
  "Sprawdza transakcje płatnicze pod kątem ryzyka nadużyć")

Zmień kierunek relacji

Rel(paymentProvider, platform,
  "Zwraca wyniki autoryzacji płatności i rozliczeń")

Użyj kierunku relacji do przedstawienia głównej zależności lub interakcji. Jeśli kierunek nie ma znaczenia architektonicznego, wybierz spójną konwencję i stosuj ją na całym diagramie.

Zmień układ

C4-PlantUML obsługuje podpowiedzi układu, takie jak:

LAYOUT_LEFT_RIGHT()

lub:

LAYOUT_TOP_DOWN()

Możesz również wpływać na rozmieszczenie za pomocą podpowiedzi kierunku:

Lay_R(klient, platforma)
Lay_D(platforma, dostawca_płatności)

Używaj wskazówek układu oszczędnie. Zbyt wiele ręcznych ograniczeń może utrudnić utrzymanie diagramu.

9. Użyj asysty AI w VPasCode

Niektóre edycje VPasCode zapewniają modyfikację diagramów wspieraną przez AI oraz naprawianie błędów w kodzie. Narzędzie może przyjmować polecenia takie jak:

Dodaj zewnętrzny serwis wykrywania nadużyć między platformą a dostawcą płatności.

lub:

Napraw błąd składni PlantUML i zachuj obecną strukturę diagramu.

VPasCode jest również dokumentowany jako obsługujący funkcje modyfikacji diagramów, diagnozowania błędów i tłumaczenia wspierane przez AI, choć dostępność może zależeć od edycji lub subskrypcji.

10. Zweryfikuj diagram PlantUML

Przed wysłaniem diagramu do Visual Paradigm Online zweryfikuj zarówno składnię, jak i architekturę.

Lista kontrolna składni

• Skrypt zaczyna się od @startuml.

• Skrypt kończy się na @enduml.

• Biblioteka C4-PlantUML jest dołączona.

• Każdy związek odwołuje się do istniejących identyfikatorów.

• Identyfikatory nie zawierają spacji ani znaków interpunkcyjnych, które mogłyby naruszyć składnię.

• Cudzysłowy są zrównoważone.

• Opisy nie są nadmiernie długie.

• Podgląd renderuje się bez błędów.

Lista kontrolna modelowania C4

• Istnieje jeden wyraźnie zidentyfikowany system zainteresowania.

• Użytkownicy są modelowani jako osoby, a nie jako systemy oprogramowania.

• Zewnętrzne aplikacje są modelowane jako systemy zewnętrzne.

• Wewnętrzne kontenery nie są uwzględniane w diagramie kontekstowym.

• Relacje opisują znaczące interakcje.

• Diagram jest zrozumiały bez czytania kodu źródłowego.

• Słownictwo jest zgodne z dokumentacją architektury projektu.

Przykład niepożądanego elementu diagramu kontekstowego

Container(api, "API zamówień", "Java", "Przetwarza zamówienia")
ContainerDb(database, "Baza danych zamówień", "PostgreSQL", "Przechowuje zamówienia")

Są to elementy na poziomie kontenera. Należą one do diagramu kontenerów C4, a nie normalnie do diagramu kontekstu systemowego.

Część 2: Wyślij diagram do Visual Paradigm Online

11. Użyj opcji „Edytuj w VP Online” lub „Edytuj diagram w VP Online”

Po poprawności wersji kodu wybierz akcję oznaczoną podobnie do:

• Edytuj w VP Online

• Edytuj diagram w VP Online

• Otwórz w wersji online

• Eksportuj do VP Online

Dokładna etykieta może się różnić w zależności od wersji interfejsu.

Ekosystem Visual Paradigm został zaprojektowany tak, aby przenosić wygenerowane diagramy z czatu AI do VPasCode w celu dopracowania na poziomie kodu, a następnie do Visual Paradigm Online w celu tradycyjnej edycji diagramów.

Edytor diagramów online jest przydatny, gdy musisz:

• Przesuwać kształty ręcznie

• Zmieniać rozmiar elementów

• Dostosowywać łączniki

• Zmieniać kolory i czcionki

• Dodawać notatki lub adnotacje

• Dodawać tytuł lub legendę

• Zastosować formatowanie prezentacyjne

• Precyzyjnie wyrównać elementy diagramu

• Przygotuj diagram do udostępnienia lub eksportu

12. Zmień diagram, korzystając z interfejsu GUI Visual Paradigm Online

Gdy diagram otworzy się w Visual Paradigm Online:

Przesuń elementy

Przeciągnij osoby i systemy zewnętrzne w wyraźny układ wokół systemu centralnego.

Typowy układ wygląda następująco:

• Osoby po lewej stronie lub u góry

• Główny system w centrum

• Systemy zewnętrzne po prawej stronie lub u dołu

Edytuj tekst

Kliknij dwukrotnie element lub wybierz jego panel specyfikacji, aby zmodyfikować:

• Nazwa

• Opis

• Stereotyp

• Etykieta relacji

Utrzymuj nazwy krótkimi, a opisy informacyjnymi.

Edytuj relacje

Wybierz łącznik, aby:

• Zmień jego kierunek

• Edytuj etykietę relacji

• Podłącz je ponownie do innego elementu

• Dostosuj jego trasowanie

• Zmień styl linii lub wygląd

Dodaj elementy

Użyj palety diagramu, aby dodać:

• Osoba

• Osoba zewnętrzna

• System

• System zewnętrzny

• Relacja

• Uwaga

• Granica

Dodawaj tylko elementy należące do poziomu kontekstu.

Zastosuj formatowanie

Możesz poprawić czytelność, dostosowując:

• Rozmiar czcionki

• Kolor wypełnienia

• Kolor obramowania

• Grubość linii

• Rozmiar kształtu

• Wyrównanie

• Odstępy

• Trasa łączników

Unikaj używania koloru jako jedynego sposobu przekazywania znaczenia. Stosuj również wyraźne etykiety.

13. Zalecany układ prezentacji

Czysty diagram kontekstowy może wykorzystywać taki układ:

Dla większych diagramów:

• Utrzymaj główny system w centrum.

• Grupuj osoby po jednej stronie.

• Grupuj zewnętrzne systemy oprogramowania po drugiej stronie.

• Unikaj przecinania linii relacji.

• Gdzie to możliwe, utrzymuj etykiety relacji w pozycji poziomej.

• Używaj krótkich etykiet zamiast akapitów.

• Zostaw wystarczającą ilość białej przestrzeni wokół systemu centralnego.

Część 3: Wybór między edycją kodu a edycją GUI

VPasCode obsługuje modele C4 poprzez PlantUML i zapewnia podgląd na żywo, podczas gdy Visual Paradigm Online oferuje tradycyjny przepływ pracy edycji diagramów wizualnych.

Część 4: Zalecany przepływ pracy od końca do końca

Szybki przepływ pracy

1. Otwórz czatbot AI Visual Paradigm.

2. Wybierz diagram kontekstu systemu C4.

3. Opisz system, użytkowników i systemy zewnętrzne.

4. Wygeneruj diagram.

5. Poproś czatbot o usunięcie szczegółów wewnętrznej implementacji.

6. Przejrzyj nazwy, relacje i zakres.

7. Wybierz Otwórz w VPasCode.

8. Edytuj źródło C4-PlantUML.

9. Wyrenderuj i zwaliduj wynik.

10. Wybierz Edytuj w VP Online.

11. Dopracuj układ i wygląd za pomocą interfejsu GUI.

12. Eksportuj lub udostępnij końcowy diagram.

Zalecany podział obowiązków

Użyj Czatbot AI do:

• Tworzenie pierwszego szkicu

• Badanie alternatywnych rozwiązań architektonicznych

• Dodawanie lub usuwanie uczestników

• Przepisywanie opisów relacji

• Przeglądanie diagramu pod kątem pominięć

Użyj VPasCode do:

• Zmiana nazw wielu elementów

• Ponowne wykorzystanie kodu diagramu

• Stosowanie spójnej składni

• Zarządzanie kodem w systemie kontroli wersji

• Wprowadzanie powtarzalnych zmian strukturalnych

• Naprawianie dyrektyw układu

• Tworzenie tekstowego źródła prawdy

Użyj Visual Paradigm Online do:

• Ostateczne pozycjonowanie wizualne

• Formatowanie prezentacji

• Ręczna regulacja łączników

• Dodawanie notatek i adnotacji

• Przygotowywanie diagramu dla interesariuszy

Część 5: Przykładowa rozmowa dotycząca dopracowania

Początkowe żądanie

Stwórz diagram kontekstu systemu C4 dla platformy dostaw żywności.

Dopracowanie 1

Dodaj Klienta, Menedżera Restauracji, Kierowcę Dostawczy i Administratora Operacji jako osoby.

Dopracowanie 2

Dodaj Dostawcę Płatności, Usługę Map i Geolokalizacji oraz Usługę Powiadomień jako systemy zewnętrzne.

Dopracowanie 3

Usuń wszystkie bazy danych, API, mikrousługi, kontenery i szczegóły implementacji. To musi pozostać diagramem kontekstu systemu C4 poziomu 1.

Dopracowanie 4

Przepisz wszystkie etykiety relacji jako zwięzłe zwroty czasownikowe i utrzymuj je poniżej 10 słów tam, gdzie to możliwe.

Dopracowanie 5

Przejrzyj diagram pod kątem brakujących relacji i niespójnej terminologii. Zachowaj „Platformę Dostaw Żywności" jako jedyny system zainteresowania.

Dopracowanie 6

Wygeneruj diagram jako C4-PlantUML i udostępnij go do edycji w VPasCode.

Część 6: Rozwiązywanie problemów

Diagram zawiera zbyt wiele szczegółów

Zapytaj:

Uprość to do rygorystycznego diagramu kontekstu systemu C4. Usuń kontenery, komponenty, bazy danych, API i nazwy technologii.

Diagram ma zbyt wiele przecinających się linii

W VPasCode:

• Spróbuj LAYOUT_LEFT_RIGHT() lub LAYOUT_TOP_DOWN().

• Dodaj ograniczone Lay_ dyrektywy.

• Skróć etykiety relacji.

• Zmniejsz liczbę wyświetlanych relacji.

• Przenieś wersję końcową do VP Online w celu ręcznego pozycjonowania.

Podgląd PlantUML wyświetla błąd

Sprawdź:

• Dołączono bibliotekę C4

• Brakujące przecinki

• Niezamknięte nawiasy

• Błędnie zapisane identyfikatory

• Relacje odnoszące się do niezdefiniowanych elementów

• Niezrównoważone cudzysłowy

• Nieprawidłowe nazwy elementów

Relacja musi odnosić się do identyfikatorów, które zostały już zadeklarowane, na przykład:

Person(customer, "Klient", "Zamawia")
System(platform, "Platforma dostaw żywności", "Przetwarza zamówienia")

Rel(customer, platform, "Zamawia")

Wersja graficzna różni się od wersji kodowej

Traktuj obie wersje jako oddzielne reprezentacje edycyjne po konwersji. Podjęj świadomą decyzję dotyczącą tego, która z nich jest źródłem prawdy:

• Użyj VPasCode jako źródło prawdy, jeśli diagram będzie utrzymywany jako kod.

• Użyj Visual Paradigm Online jako źródło prawdy, jeśli interesariusze będą często dostosowywać go wizualnie.

Unikaj wprowadzania niezwiązanych zmian w obu miejscach bez ich synchronizacji.

Wygenerowany diagram używa niewłaściwego poziomu C4

Zapytaj bota czatowego:

Wygeneruj ponownie ten schemat wyłącznie jako diagram kontekstu systemu C4. Pokaż osoby, system zainteresowania oraz zewnętrzne systemy oprogramowania. Nie pokazuj kontenerów ani komponentów.

Końcowa lista kontrolna jakości

Przed opublikowaniem schematu potwierdź, że:

• Schemat posiada jasny tytuł.

• System zainteresowania jest wyraźnie zaznaczony.

• Osoby i zewnętrzne systemy są poprawnie sklasyfikowane.

• Relacje posiadają znaczące etykiety.

• Żaden szczegół wewnętrznej implementacji nie przedostał się do widoku kontekstowego.

• Nazwy używają spójnej terminologii.

• Schemat jest czytelny przy normalnym powiększeniu.

• Linie relacji nie zasłaniają kształtów ani etykiet.

• Źródło PlantUML renderuje się poprawnie.

• Wersja VP Online odpowiada zatwierdzonej architekturze.

• Ostateczny schemat został sprawdzony przez osobę zaznajomioną z systemem.

Najbardziej efektywny przepływ pracy polega na wykorzystaniu bota czatowego AI do szybkiego modelowania, VPasCode do precyzyjnej i powtarzalnej edycji C4-PlantUML oraz Visual Paradigm Online do ostatecznego dopracowania wizualnego. Łączy to generowanie konwersacyjne, utrzymanie diagramu jako kodu oraz edycję prezentacji opartą na GUI w jednym procesie.

Ten post dostępny jest również w Deutsch, English, Español, Français, English, Bahasa Indonesia, 日本語, Portuguese and Ру́сский