diff --git a/instruction/erd/erd-plantuml-create.md b/instruction/erd/erd-plantuml-create.md new file mode 100644 index 0000000..9a2610d --- /dev/null +++ b/instruction/erd/erd-plantuml-create.md @@ -0,0 +1,324 @@ +# ERD / PlantUML / Buat + +Berikut panduan cara membuat ERD dengan PlantUML. + +Acuan format standarnya adalah `plan/milestone/moop.puml` (sumber) dan +`plan/milestone/moop.png` (hasil render). Ikuti gaya itu persis — header-nya sama, +tata letak entity-nya sama, cara menulis constraint dan relasinya juga sama. + +Yang perlu disiapkan: +- prefix modul/domain (misal `moop`, `chat`, `memories`) — dipakai sebagai prefix nama tabel/entity +- daftar tabel beserta kolomnya +- relasi antar tabel (siapa mereferensi siapa, wajib atau boleh kosong) +- direktori tujuan untuk pasangan file `.puml` + `.png` (bawaan: `plan/milestone/`) + +Bahasa penulisan: **isi diagram tetap bahasa Inggris** (nama tabel, tipe, dan teks +constraint seperti `on update cascade` / `null priority = disabled`) supaya konsisten +dengan skema SQL dan `moop.puml`. Penjelasan di dokumen ini saja yang bahasa Indonesia. + +## Penamaan file dan lokasinya + +- satu diagram = satu pasangan file: `.puml` dan `.png` +- file `.puml` dan `.png` diletakkan berdampingan di direktori yang sama +- nama diagram mengikuti nama fitur/modul, kebab-case atau huruf kecil biasa + (contoh: `moop.puml`, `2-basic-features.puml`) +- jangan pernah men-commit `.puml` tanpa `.png` hasil render-nya, dan render ulang setiap + kali `.puml` diubah + +## Header wajib + +Setiap ERD dibuka persis seperti ini. Tanpa judul, tanpa legenda, tanpa blok penulis: + +```plantuml +@startuml + +hide circle +skinparam linetype ortho + +... + +@enduml +``` + +- `hide circle` menghapus lingkaran actor di depan nama entity. +- `skinparam linetype ortho` membuat garis relasi menyiku/lurus supaya diagram tetap enak dibaca. +- sisakan satu baris kosong setelah `@startuml` dan sebelum `@enduml`. +- jangan menambah `skinparam` lain, warna, atau blok `