de_DEen_USes_ESfr_FRhi_INid_IDjapl_PLpt_PTru_RU

Buat Diagram Konteks C4 yang Dapat Diedit dengan Chatbot AI Visual Paradigm

Chatbot AI Visual Paradigm memungkinkan pembuatan Diagram Konteks Sistem C4 dari deskripsi sederhana dalam bahasa alami mengenai aplikasi, penggunanya, dan sistem eksternal yang berinteraksi dengannya. Namun, diagram yang dihasilkan oleh AI paling bermanfaat ketika tetap dapat diedit dan dipelihara setelah dibuat.

Panduan ini mendemonstrasikan alur kerja end-to-end untuk menghasilkan diagram konteks Platform Pengiriman Makanan menggunakan C4-PlantUML. Anda akan belajar cara beralih dari diagram yang dihasilkan AI ke kode PlantUML yang dapat diedit, menyempurnakan model di VPasCode, dan melanjutkan pengeditan secara visual di Visual Paradigm Online. Pendekatan ini menggabungkan kecepatan pemodelan yang dibantu AI dengan fleksibilitas diagram-sebagai-kode dan kenyamanan editor diagram grafis.

Alur kerja empat langkah yang menunjukkan bagaimana Visual Paradigm AI Chatbot menghasilkan Diagram Konteks Sistem C4 yang dapat diedit dari bahasa alami ke kode dan editor visual.

Visual Paradigm menyediakan alur kerja praktis untuk mengubah deskripsi arsitektur dalam bahasa alami menjadi Diagram Konteks C4 yang dapat diedit:

  1. Deskripsikan sistem di Chatbot AI Visual Paradigm.

    Visual Paradigm AI Chatbot menampilkan diagram Konteks Sistem C4 yang dapat diedit untuk Sistem TI Grup Perbankan, menampilkan pengguna dan sistem eksternal.

  2. Hasilkan dan tinjau Diagram Konteks Sistem C4.

  3. Buka hasilnya di VPasCode sebagai C4-PlantUML.

    Chatbot AI Visual Paradigm menampilkan diagram konteks sistem perbankan C4 yang dihasilkan dengan opsi untuk mengedit melalui VPasCode atau Visual Paradigm Online.

  4. Modifikasi diagram dengan mengedit kode PlantUML.

    Antarmuka VPasCode menampilkan kode C4-PlantUML berdampingan dengan diagram konteks Sistem TI Grup Perbankan yang dihasilkan, menampilkan pengguna dan sistem eksternal.

  5. Opsional: kirim hasilnya ke Visual Paradigm Online.

    Antarmuka Visual Paradigm menampilkan diagram Konteks Sistem C4 yang dapat diedit untuk platform perbankan, menampilkan orang, sistem perangkat lunak, dan interaksi eksternal.

  6. Modifikasi diagram secara visual menggunakan editor diagram seret dan lepas.

Ini memberikan Anda dua jalur pengeditan:

  • Pengeditan berbasis kode:VPasCode dan C4-PlantUML

  • Pengeditan berbasis GUI:Editor Diagram Visual Paradigm Online

Chatbot AI Visual Paradigm mendukung diagram Konteks Sistem, Kontainer, Komponen, dan Deployment C4. Chatbot ini juga dapat menyempurnakan diagram yang dihasilkan melalui perintah dalam bahasa alami, seperti menambahkan, menghapus, mengganti nama, atau menghubungkan ulang elemen.


1. Pahami Diagram Konteks C4

Diagram Konteks C4 adalah tampilan tingkat tertinggi dari sebuah sistem perangkat lunak. Diagram ini menampilkan:

  • Sistem yang menjadi fokusSistem yang menjadi fokus

  • Pengguna manusia dan aktor organisasi

  • Sistem perangkat lunak eksternal

  • Hubungan penting antara elemen-elemen ini

  • Deskripsi singkat tentang cara kerja setiap hubungan

Diagram ini biasanya tidak menampilkan layanan internal, basis data, kelas, API, atau detail infrastruktur. Elemen-elemen tersebut termasuk dalam diagram C4 tingkat lebih rendah.

Sebagai contoh, diagram konteks untuk platform pengiriman makanan online mungkin berisi:

  • Pelanggan

  • Manajer Restoran

  • Pengemudi Pengiriman

  • Penyedia Pembayaran

  • Layanan Peta dan Geolokasi

  • Layanan Notifikasi

  • Platform Pengiriman Makanan

Sistem pusat harus tetap menjadi fokus visual. Orang dan sistem eksternal harus ditempatkan di sekitarnya.


2. Siapkan Perintah AI yang Baik

Kualitas diagram yang dihasilkan sangat bergantung pada deskripsi arsitektur yang disediakan untuk chatbot.

Perintah yang berguna menentukan:

  • Nama sistem

  • Tujuan sistem

  • Orang yang menggunakannya

  • Sistem eksternal yang berkomunikasi dengannya

  • Hubungan di antara mereka

  • Tingkat diagram C4 yang diinginkan

  • Format output yang diinginkan

  • Apa yang tidak boleh disertakan

Contoh perintah

Buat Diagram Konteks Sistem C4 untuk platform pengiriman makanan online.

Sistem yang diminati:
Platform Pengiriman Makanan — memungkinkan pelanggan menjelajahi restoran, memesan, melakukan pembayaran, dan melacak pengiriman.

Orang:
1. Pelanggan — menjelajahi restoran, memesan, membayar, dan melacak pengiriman.
2. Manajer Restoran — mengelola menu, menerima pesanan, dan memperbarui status pesanan.
3. Pengemudi Pengiriman — menerima tugas pengiriman dan memperbarui progres pengiriman.
4. Administrator Operasi — memantau aktivitas platform dan menangani masalah dukungan.

Sistem eksternal:
1. Penyedia Pembayaran — mengotorisasi dan menangkap pembayaran pelanggan.
2. Layanan Peta dan Geolokasi — menyediakan alamat, rute, dan lokasi pengiriman.
3. Layanan Notifikasi — mengirim email, SMS, dan notifikasi push.

Hubungan:
- Pelanggan menggunakan Platform Pengiriman Makanan untuk menjelajahi restoran, memesan, melakukan pembayaran, dan melacak pengiriman.
- Manajer Restoran menggunakan Platform Pengiriman Makanan untuk mengelola menu dan memproses pesanan.
- Pengemudi Pengiriman menggunakan Platform Pengiriman Makanan untuk menerima tugas pengiriman dan memperbarui status pengiriman.
- Administrator Operasi menggunakan Platform Pengiriman Makanan untuk memantau operasi dan menyelesaikan masalah.
- Platform Pengiriman Makanan menggunakan Penyedia Pembayaran untuk mengotorisasi dan menangkap pembayaran.
- Platform Pengiriman Makanan menggunakan Layanan Peta dan Geolokasi untuk menghitung rute dan melacak lokasi.
- Platform Pengiriman Makanan menggunakan Layanan Notifikasi untuk mengirim notifikasi.

Hasilkan diagram Konteks Sistem C4 yang bersih. Jangan tampilkan wadah internal, komponen, basis data, kelas, atau infrastruktur penyebaran. Gunakan label hubungan yang ringkas.

Instruksi eksplisit untuk mengecualikan detail internal sangat penting. Tanpanya, generator AI dapat menghasilkan diagram yang mencampurkan informasi tingkat konteks dan tingkat wadah.


3. Hasilkan Diagram di Chatbot AI Visual Paradigm

Buka Chatbot AI Visual Paradigm dan mulai percakapan baru atau sesi pembuatan diagram.

Bergantung pada antarmuka dan edisi langganan, chatbot mungkin menyediakan pemilih tipe diagram. Pilih:

  • Model C4

  • Diagram Konteks Sistem

Kemudian masukkan perintahnya.

Alur kerja chatbot umum Visual Paradigm adalah:

  1. Jelaskan diagramnya.

  2. Biarkan AI menghasilkan model awal.

  3. Tinjau hasilnya.

  4. Sempurnakan dengan perintah bahasa alami.

  5. Ekspor atau lanjutkan pengeditan di alat Visual Paradigm lainnya.

Tinjau hasil pertama

Periksa apakah diagram berisi:

  • Tepat satu sistem pusat

  • Semua orang yang diperlukan

  • Semua sistem eksternal yang relevan

  • Arah hubungan yang benar

  • Deskripsi hubungan yang ringkas

  • Tidak ada layanan internal atau basis data yang tidak perlu

  • Penamaan yang konsisten

  • Tata letak yang mudah dibaca

Diagram yang dihasilkan adalah titik awal, bukan pengganti tinjauan arsitektur.


4. Sempurnakan Diagram Melalui Percakapan

Chatbot dapat memodifikasi diagram menggunakan bahasa sehari-hari.

Tambahkan elemen

Tambahkan Agen Dukungan Pelanggan yang menggunakan Platform Pengiriman Makanan untuk menyelidiki masalah pelanggan dan memproses pengembalian dana.

Tambahkan sistem eksternal

Tambahkan Layanan Deteksi Penipuan Eksternal yang digunakan oleh Platform Pengiriman Makanan untuk mengevaluasi pembayaran yang mencurigakan.

Ganti nama elemen

Ganti nama "Layanan Notifikasi" menjadi "Layanan Pesan dan Notifikasi."

Ubah hubungan

Ubah hubungan antara Pengemudi Pengiriman dan Platform Pengiriman Makanan menjadi:
"Menerima tugas pengiriman dan mengirimkan pembaruan status pengiriman."

Hapus elemen

Hapus Administrator Operasi dari diagram.

Perbaiki tata letak

Atur ulang diagram sehingga orang muncul di bagian atas, sistem eksternal muncul di bagian bawah, dan Platform Pengiriman Makanan tetap berada di tengah.

Sederhanakan diagram

Sederhanakan ini menjadi Diagram Konteks Sistem C4 yang ketat. Hapus detail implementasi, basis data, API, mikro layanan, dan komponen internal.

Minta tinjauan konsistensi

Tinjau diagram untuk hubungan yang hilang, label yang ambigu, sistem duplikat, dan elemen yang tidak seharusnya ada dalam Diagram Konteks C4.

Dokumentasi Chatbot AI menjelaskan pendekatan iteratif ini, termasuk perintah untuk menambahkan gerbang pembayaran, mengganti nama elemen, mengubah hubungan, dan melakukan refactoring diagram.


Bagian 1: Buka Diagram di VPasCode untuk Pengeditan Kode

5. Gunakan “Buka di VPasCode” atau “Edit di VPasCode”

Setelah membuat dan menyempurnakan diagram, gunakan tindakan yang diberi label serupa dengan:

  • Buka di VPasCode

  • Edit di VPasCode

  • Buka Kode

  • Hasilkan Kode untuk Pengeditan

Label tombol yang tepat dapat bervariasi tergantung pada antarmuka saat ini.

Ini memindahkan kode diagram ke VPasCode, di mana Anda dapat mengedit diagram sebagai teks sambil melihat pratinjau yang dirender secara langsung. Visual Paradigm mendeskripsikan VPasCode sebagai editor diagram-sebagai-kode berbasis browser yang mendukung PlantUML, model C4, Mermaid, Graphviz, dan format sintaks lainnya.

Kode yang dihasilkan harus menggunakan C4-PlantUML, biasanya dengan:

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

Skrip yang dihasilkan mungkin menggunakan URL include yang berbeda atau versi pustaka yang didukung secara internal. Pertahankan include yang dihasilkan oleh VPasCode kecuali Anda memiliki alasan khusus untuk mengubahnya.


6. Pahami Struktur C4-PlantUML

Diagram konteks C4-PlantUML yang khas berisi bagian-bagian berikut:

Antarmuka VPasCode menampilkan kode C4-PlantUML berdampingan dengan diagram konteks yang dihasilkan yang menampilkan Pelanggan, Platform Pengiriman Makanan, dan Penyedia Pembayaran.

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

LAYOUT_LEFT_RIGHT()

Person(customer, "Pelanggan", "Menempatkan pesanan makanan dan melacak pengiriman.")
System(platform, "Platform Pengiriman Makanan", "Memungkinkan pelanggan memesan makanan dan melacak pengiriman.")
System_Ext(payment, "Penyedia Pembayaran", "Mengotorisasi dan menangkap pembayaran.")

Rel(customer, platform, "Menempatkan pesanan dan melacak pengiriman")
Rel(platform, payment, "Mengotorisasi dan menangkap pembayaran")

@enduml

Jenis elemen utama

Elemen Tujuan Contoh
Orang Pengguna manusia atau peran Person(customer, "Pelanggan", "...")
Person_Ext Orang atau aktor eksternal Person_Ext(driver, "Kurir Pengiriman", "...")
Sistem Sistem utama yang menjadi perhatian System(platform, "Platform Pengiriman Makanan", "...")
System_Ext Sistem perangkat lunak eksternal System_Ext(payment, "Penyedia Pembayaran", "...")
Batas Perusahaan Batas organisasi opsional Mengelompokkan sistem yang milik organisasi
Rel Hubungan antara elemen Rel(customer, platform, "Menggunakan")

Argumen pertama adalah pengenal internal. Yang kedua adalah nama tampilan. Yang ketiga adalah deskripsi.


7. Edit Diagram di VPasCode

VPasCode biasanya menampilkan:

  • Kode sumber di panel editor

  • Diagram yang dirender di panel pratinjau

  • Aksi untuk mengekspor, berbagi, menyalin, atau membuka hasil di produk Visual Paradigm lainnya

VPasCode menyediakan rendering langsung dan mendukung pengeditan kode secara langsung. VPasCode juga dapat mendeteksi format diagram yang didukung ketika kode ditempelkan ke editor.

Contoh: kode C4-PlantUML yang ditingkatkan

Antarmuka VPasCode menampilkan kode C4-PlantUML berdampingan dengan diagram konteks sistem pengiriman makanan yang dihasilkan dengan aktor dan sistem.

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

title Platform Pengiriman Makanan — Konteks Sistem

LAYOUT_LEFT_RIGHT()
SHOW_LEGEND()

Person(customer, "Pelanggan",
  "Menjelajahi restoran, memesan, membayar, dan melacak pengiriman.")

Person(restaurantManager, "Manajer Restoran",
  "Mengelola menu, menerima pesanan, dan memperbarui status pesanan.")

Person(deliveryDriver, "Pengemudi Pengiriman",
  "Menerima tugas pengiriman dan memperbarui progres pengiriman.")

Person(operationsAdmin, "Administrator Operasi",
  "Memantau operasi platform dan menangani masalah dukungan.")

System(platform, "Platform Pengiriman Makanan",
  "Memungkinkan pemesanan makanan, pembayaran, manajemen restoran, dan pelacakan pengiriman.")

System_Ext(paymentProvider, "Penyedia Pembayaran",
  "Mengotorisasi dan menangkap pembayaran pelanggan.")

System_Ext(mapService, "Layanan Peta dan Geolokasi",
  "Menyediakan alamat, rute, dan data lokasi.")

System_Ext(notificationService, "Layanan Notifikasi",
  "Mengirim email, SMS, dan notifikasi push.")

Rel(customer, platform,
  "Menjelajahi restoran, memesan, membayar, dan melacak pengiriman")

Rel(restaurantManager, platform,
  "Mengelola menu dan memproses pesanan restoran")

Rel(deliveryDriver, platform,
  "Menerima tugas pengiriman dan menyerahkan status pengiriman")

Rel(operationsAdmin, platform,
  "Memantau operasi dan menangani masalah dukungan")

Rel(platform, paymentProvider,
  "Mengotorisasi dan menangkap pembayaran")

Rel(platform, mapService,
  "Menghitung rute dan melacak lokasi pengiriman")

Rel(platform, notificationService,
  "Mengirim notifikasi pesanan, pembayaran, dan pengiriman")

@enduml


8. Lakukan Perubahan Umum pada Tingkat Kode

Ubah nama sistem

System(platform, "Platform Pengiriman Makanan",
  "Mengkoordinasikan pemesanan dan pengiriman makanan.")

Tambahkan orang baru

Person(customerSupport, "Agen Dukungan Pelanggan",
  "Menyelidiki masalah pelanggan dan memproses pengembalian dana.")

Rel(customerSupport, platform,
  "Menyelidiki masalah dan menangani pengembalian dana")

Tambahkan sistem eksternal baru

System_Ext(fraudService, "Layanan Deteksi Penipuan",
  "Mengevaluasi aktivitas pembayaran yang mencurigakan.")

Rel(platform, fraudService,
  "Memeriksa transaksi pembayaran untuk risiko penipuan")

Ubah arah hubungan

Rel(paymentProvider, platform,
  "Mengembalikan hasil otorisasi dan penyelesaian pembayaran")

Gunakan arah relasi untuk mewakili ketergantungan atau interaksi utama. Jika arah tidak penting secara arsitektural, pilih konvensi yang konsisten dan terapkan secara konsisten di seluruh diagram.

Ubah tata letak

C4-PlantUML mendukung petunjuk tata letak seperti:

atau:

Anda juga dapat memengaruhi penempatan dengan petunjuk arah:

Gunakan petunjuk tata letak secara hemat. Terlalu banyak batasan manual dapat membuat diagram lebih sulit dipelihara.


9. Gunakan Bantuan AI VPasCode

Beberapa edisi VPasCode menyediakan modifikasi diagram dan perbaikan kesalahan kode yang dibantu AI. Alat ini dapat menerima instruksi seperti:

Tambahkan layanan deteksi penipuan eksternal antara platform dan penyedia pembayaran.

atau:

Perbaiki kesalahan sintaks PlantUML dan pertahankan struktur diagram saat ini.

VPasCode juga didokumentasikan mendukung fitur modifikasi diagram, diagnosis kesalahan, dan terjemahan yang didukung AI, meskipun ketersediaannya mungkin bergantung pada edisi atau langganan.


10. Validasi Diagram PlantUML

Sebelum mengirim diagram ke Visual Paradigm Online, validasi baik sintaks maupun arsitekturnya.

Ceklis sintaks

  • Skrip dimulai dengan @startuml.

  • Skrip diakhiri dengan @enduml.

  • Perpustakaan C4-PlantUML disertakan.

  • Setiap relasi merujuk pada pengenal yang sudah ada.

  • Pengenal tidak mengandung spasi atau tanda baca yang dapat merusak sintaks.

  • Tanda kutip seimbang.

  • Deskripsi tidak terlalu panjang.

  • Pratinjau dirender tanpa kesalahan.

Ceklis pemodelan C4

  • Ada satu sistem yang jelas diidentifikasi sebagai sistem yang diminati.

  • Pengguna dimodelkan sebagai orang, bukan sebagai sistem perangkat lunak.

  • Aplikasi eksternal dimodelkan sebagai sistem eksternal.

  • Kontainer internal tidak disertakan dalam diagram konteks.

  • Relasi menggambarkan interaksi yang bermakna.

  • Diagram ini dapat dipahami tanpa membaca kode sumber.

  • Terminologi ini sesuai dengan dokumentasi arsitektur proyek.

Contoh elemen diagram konteks yang tidak diinginkan

Container(api, "Order API", "Java", "Memproses pesanan")
ContainerDb(database, "Order Database", "PostgreSQL", "Menyimpan pesanan")

Ini adalah elemen tingkat kontainer. Elemen ini seharusnya berada dalam Diagram Kontainer C4, bukan biasanya dalam Diagram Konteks Sistem.


Bagian 2: Kirim Diagram ke Visual Paradigm Online

11. Gunakan “Edit di VP Online” atau “Edit di VP Online Diagram”

Setelah versi kode benar, pilih tindakan yang berlabel serupa dengan:

  • Edit di VP Online

  • Edit di VP Online Diagram

  • Buka di Online

  • Ekspor ke VP Online

Label yang tepat dapat bervariasi tergantung versi antarmuka.

Ekosistem Visual Paradigm dirancang untuk memindahkan diagram yang dihasilkan dari AI Chatbot ke VPasCode untuk penyempurnaan tingkat kode, lalu ke Visual Paradigm Online untuk pengeditan diagram tradisional.

Editor Diagram Online berguna ketika Anda perlu:

  • Pindahkan bentuk secara manual

  • Ubah ukuran elemen

  • Sesuaikan konektor

  • Ubah warna dan jenis huruf

  • Tambahkan catatan atau anotasi

  • Tambahkan judul atau legenda

  • Terapkan format presentasi

  • Sejajarkan elemen diagram secara presisi

  • Siapkan diagram untuk dibagikan atau diekspor


12. Modifikasi Diagram Menggunakan GUI Visual Paradigm Online

Setelah diagram terbuka di Visual Paradigm Online:

Pindahkan elemen

Seret orang dan sistem eksternal ke dalam susunan yang jelas di sekitar sistem pusat.

Tata letak umum adalah:

  • Orang di sebelah kiri atau di atas

  • Sistem utama di tengah

  • Sistem eksternal di sebelah kanan atau di bawah

Edit teks

Klik dua kali pada elemen atau pilih panel spesifikasinya untuk memodifikasi:

  • Nama

  • Deskripsi

  • Stereotipe

  • Label hubungan

Jaga nama tetap singkat dan deskripsi informatif.

Edit hubungan

Pilih penghubung untuk:

  • Ubah arahnya

  • Edit label hubungan

  • Hubungkan kembali ke elemen lain

  • Sesuaikan jalurnya

  • Ubah gaya atau tampilan garis

Tambahkan elemen

Gunakan palet diagram untuk menambahkan:

  • Orang

  • Orang Eksternal

  • Sistem

  • Sistem Eksternal

  • Hubungan

  • Catatan

  • Batas

Tambahkan hanya elemen yang termasuk pada tingkat konteks.

Terapkan pemformatan

Anda dapat meningkatkan keterbacaan dengan menyesuaikan:

  • Ukuran font

  • Warna isi

  • Warna batas

  • Ketebalan garis

  • Ukuran bentuk

  • Perataan

  • Jarak

  • Rute penghubung

Hindari menggunakan warna sebagai satu-satunya cara untuk menyampaikan makna. Gunakan juga label yang jelas.


13. Tata Letak Presentasi yang Direkomendasikan

Diagram konteks yang bersih mungkin menggunakan susunan ini:

Antarmuka VPasCode menampilkan diagram konteks C4 untuk platform pengiriman makanan, menampilkan interaksi pelanggan dan manajer dengan sistem pusat.

Untuk diagram yang lebih besar:

  • Pertahankan sistem utama di tengah.

  • Kelompokkan orang di satu sisi.

  • Kelompokkan sistem perangkat lunak eksternal di sisi lain.

  • Hindari garis hubungan yang saling bersilangan.

  • Pertahankan label hubungan secara horizontal jika memungkinkan.

  • Gunakan label pendek daripada paragraf.

  • Sediakan ruang putih yang cukup di sekitar sistem pusat.


Bagian 3: Memilih antara Pengeditan Kode dan GUI

Metode pengeditan Paling cocok untuk Keuntungan Keterbatasan
Chatbot AI Generasi awal dan perubahan konseptual Cepat, bersifat percakapan, cocok untuk mengeksplorasi alternatif Memerlukan tinjauan arsitektur
VPasCode Pengeditan tingkat kode yang presisi Teks yang dapat dilacak versinya, perubahan yang dapat diulang, pengeditan massal yang cepat Memerlukan pemahaman terhadap sintaks PlantUML atau C4
Visual Paradigm Online Penataan dan presentasi visual Pengeditan seret-lepas, pemformatan, kontrol tata letak manual Pengeditan manual mungkin lebih sulit direproduksi sebagai kode
Visual Paradigm Desktop Pemodelan formal dan integrasi proyek Pemodelan tingkat lanjut dan alur kerja perusahaan Mungkin memerlukan edisi desktop atau lisensi tertentu

VPasCode mendukung model C4 melalui PlantUML dan menyediakan pratinjau langsung, sedangkan Visual Paradigm Online menawarkan alur kerja pengeditan diagram visual tradisional.


Bagian 4: Alur Kerja End-to-End yang Direkomendasikan

Alur kerja cepat

  1. Buka Chatbot AI Visual Paradigm.

  2. Pilih Diagram Konteks Sistem C4.

  3. Deskripsikan sistem, pengguna, dan sistem eksternal.

  4. Hasilkan diagram.

  5. Minta chatbot untuk menghapus detail implementasi internal.

  6. Tinjau nama, hubungan, dan ruang lingkup.

  7. Pilih Buka di VPasCode.

  8. Edit sumber C4-PlantUML.

  9. Rendern dan validasi hasilnya.

  10. Pilih Edit di VP Online.

  11. Sempurnakan tata letak dan tampilan menggunakan GUI.

  12. Ekspor atau bagikan diagram akhir.

Pembagian tanggung jawab yang direkomendasikan

Gunakan Chatbot AI untuk:

  • Membuat draf pertama

  • Menjelajahi alternatif arsitektur

  • Menambahkan atau menghapus peserta

  • Menulis ulang deskripsi hubungan

  • Meninjau diagram untuk menemukan kelalaian

Gunakan VPasCode untuk:

  • Menamai ulang banyak elemen

  • Menggunakan kembali kode diagram

  • Menerapkan sintaks yang konsisten

  • Mengelola kode dalam kontrol versi

  • Melakukan perubahan struktural yang dapat diulang

  • Memperbaiki direktif tata letak

  • Menghasilkan sumber kebenaran berbasis teks

Gunakan Visual Paradigm Online untuk:

  • Penempatan visual akhir

  • Format presentasi

  • Penyesuaian konektor secara manual

  • Menambahkan catatan dan anotasi

  • Menyiapkan diagram untuk pemangku kepentingan


Bagian 5: Percakapan Contoh Penyempurnaan

Permintaan awal

Buat Diagram Konteks Sistem C4 untuk platform pengiriman makanan.

Penyempurnaan 1

Tambahkan Pelanggan, Manajer Restoran, Pengemudi Pengiriman, dan Administrator Operasi sebagai orang.

Penyempurnaan 2

Tambahkan Penyedia Pembayaran, Layanan Peta dan Geolokasi, serta Layanan Notifikasi sebagai sistem eksternal.

Penyempurnaan 3

Hapus semua basis data, API, mikro layanan, kontainer, dan detail implementasi. Ini harus tetap menjadi Diagram Konteks Sistem C4 Tingkat 1.

Penyempurnaan 4

Tulis ulang semua label hubungan sebagai frasa kata kerja yang ringkas dan jaga agar tetap di bawah 10 kata jika memungkinkan.

Penyempurnaan 5

Periksa diagram untuk hubungan yang hilang dan terminologi yang tidak konsisten. Pertahankan “Platform Pengiriman Makanan” sebagai satu-satunya sistem yang menjadi fokus.

Penyempurnaan 6

Hasilkan diagram sebagai C4-PlantUML dan buat tersedia untuk diedit di VPasCode.

Bagian 6: Penyelesaian Masalah

Diagram berisi terlalu banyak detail

Tanyakan:

Sederhanakan ini menjadi Diagram Konteks Sistem C4 yang ketat. Hapus kontainer, komponen, basis data, API, dan nama teknologi.

Diagram memiliki terlalu banyak garis yang saling bersilangan

Di VPasCode:

  • Coba LAYOUT_LEFT_RIGHT() atau LAYOUT_TOP_DOWN().

  • Tambahkan terbatas Lay_ direktif.

  • Perpendek label relasi.

  • Kurangi jumlah relasi yang ditampilkan.

  • Pindahkan versi final ke VP Online untuk penyesuaian posisi secara manual.

Pratinjau PlantUML menampilkan kesalahan

Periksa:

  • Pustaka C4 menyertakan

  • Koma yang hilang

  • Tanda kurung yang tidak ditutup

  • Identifikator yang salah eja

  • Relasi yang merujuk pada elemen yang tidak didefinisikan

  • Tanda kutip yang tidak seimbang

  • Nama elemen yang salah

Sebuah relasi harus merujuk pada identifikator yang telah dideklarasikan sebelumnya, misalnya:

Person(customer, "Pelanggan", "Meletakkan pesanan")
System(platform, "Platform Pengiriman Makanan", "Memproses pesanan")

Rel(customer, platform, "Meletakkan pesanan")

Versi GUI berbeda dari versi kode

Anggap kedua versi sebagai representasi pengeditan yang terpisah setelah konversi. Buat keputusan sadar mengenai mana yang menjadi sumber kebenaran:

  • Gunakan VPasCode sebagai sumber kebenaran jika diagram akan dipelihara sebagai kode.

  • Gunakan Visual Paradigm Online sebagai sumber kebenaran jika pemangku kepentingan akan sering menyesuaikannya secara visual.

Hindari membuat perubahan yang tidak terkait di kedua tempat tanpa menyinkronkannya.

Diagram yang dihasilkan menggunakan level C4 yang salah

Tanyakan kepada chatbot:

Buat ulang ini hanya sebagai Diagram Konteks Sistem C4. Tampilkan orang, sistem yang menjadi fokus, dan sistem perangkat lunak eksternal. Jangan tampilkan kontainer atau komponen.

Ceklis Kualitas Akhir

Sebelum mempublikasikan diagram, pastikan bahwa:

  • Diagram memiliki judul yang jelas.

  • Sistem yang menjadi fokus terlihat jelas.

  • Orang dan sistem eksternal diklasifikasikan dengan benar.

  • Hubungan memiliki label yang bermakna.

  • Tidak ada detail implementasi internal yang bocor ke dalam tampilan konteks.

  • Nama menggunakan terminologi yang konsisten.

  • Diagram dapat dibaca pada tingkat zoom normal.

  • Garis hubungan tidak menutupi bentuk atau label.

  • Sumber PlantUML berhasil dirender.

  • Versi VP Online sesuai dengan arsitektur yang disetujui.

  • Diagram akhir telah ditinjau oleh seseorang yang memahami sistem tersebut.

Alur kerja yang paling efektif adalah menggunakan AI Chatbot untuk pemodelan cepat, VPasCode untuk pengeditan C4-PlantUML yang presisi dan dapat diulang, dan Visual Paradigm Online untuk penyempurnaan visual akhir. Ini menggabungkan generasi berbasis percakapan, kemampuan pemeliharaan diagram-sebagai-kode, dan pengeditan presentasi berbasis GUI dalam satu proses.

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