BPMN Documentation Versioning

---

Fitur Documentation Versioning pada BPMN Editor di AlurKerja On Premise digunakan untuk mengelola dokumentasi BPMN secara terstruktur berdasarkan versi, pada setiap elemen seperti Process, Participant, Lane, Task, Event, Gateway, dan elemen lainnya. Dengan fitur ini, perubahan dokumentasi tidak menimpa versi sebelumnya karena setiap pembaruan disimpan dalam versi tertentu.

---

Manfaat Documentation Versioning

• Perubahan dapat ditelusuri (Traceable): riwayat perubahan tersimpan per versi dan mudah dilacak.
• Riwayat dokumentasi tetap terjaga: dokumentasi lama tidak tertimpa perubahan baru.
• Menghindari kehilangan informasi: perubahan terdokumentasi di setiap versi.
• Memudahkan proses audit dan review: versi sebelumnya tetap dapat dijadikan referensi.

Konsep Versioning pada Documentation Manager

• Current Version (Versi Aktif): versi yang sedang digunakan dan masih bisa diedit.
• New Version: membuat versi dokumentasi baru saat ada perubahan proses atau pembaruan dokumentasi.
• Publish: mempublikasikan versi final menjadi versi resmi; setelah dipublish tidak dapat diedit.

Setiap versi dokumentasi bersifat terpisah, sehingga perubahan pada versi baru tidak mempengaruhi versi sebelumnya.

Mengakses Documentation Manager

Untuk mengelola dokumentasi BPMN, lakukan langkah berikut:

1. Buka diagram BPMN pada BPMN Editor.

2. Klik menu Documentation pada toolbar editor.

   

3. Sistem akan menampilkan halaman Documentation Manager yang digunakan untuk mengelola dokumentasi setiap elemen BPMN.

   

Membuat Dokumentasi Baru

Untuk membuat dokumentasi BPMN baru dari awal, lakukan langkah berikut:

1. Pada halaman Documentation, klik tombol Initialize Documentation.

   

2. Sistem akan membuat struktur dokumentasi berdasarkan elemen BPMN yang terdapat pada diagram.

   

3. Setelah proses berhasil, sistem akan menampilkan notifikasi bahwa dokumentasi berhasil diinisialisasi.

   

4. Pilih elemen BPMN di panel kiri (Process / Lane / Task).

   

5. Isi dokumentasi pada editor sesuai dengan penjelasan proses bisnis yang diinginkan.

   

6. Klik Save Changes untuk menyimpan dokumentasi yang telah dibuat.

   

Membuka Dokumentasi Sebelumnya

Fitur Load Existing Documentation digunakan untuk memuat dokumentasi yang sudah pernah dibuat sebelumnya agar dapat digunakan kembali pada struktur dokumentasi yang baru dengan cara:

1. Pada halaman Documentation, klik tombol Load Existing Documentation.

   

2. Sistem akan memuat dokumentasi yang sudah ada dari versi sebelumnya dan menampilkannya pada editor dokumentasi.

   

3. Dokumentasi yang dimuat akan otomatis dipetakan ke dalam struktur dokumentasi BPMN yang baru.

4. Anda dapat melakukan penyesuaian atau pembaruan isi dokumentasi sesuai kebutuhan.

Mengedit Dokumentasi BPMN

Untuk mengubah atau memperbarui dokumentasi BPMN, lakukan langkah berikut:

1. Pilih elemen BPMN di panel kiri (Process / Lane / Task / Event / Gateway).
2. Isi atau perbarui dokumentasi pada editor.
3. Klik Save Changes untuk menyimpan perubahan dokumentasi pada versi tersebut.

Fitur Tambahan pada Editor Dokumentasi

Beberapa fitur yang tersedia pada editor dokumentasi antara lain:

• Toggle Language (IND): Digunakan untuk mengatur bahasa dokumentasi yang digunakan.
• Generate with AI: Digunakan untuk menghasilkan atau menyempurnakan isi dokumentasi secara otomatis dengan bantuan AI.
• Save: Digunakan untuk menyimpan perubahan dokumentasi yang telah dilakukan.

Membuat Versi Baru

Untuk membuat versi dokumentasi baru pada BPMN, lakukan langkah berikut:

1. Klik tombol New Version pada halaman Documentation Manager.

2. Sistem akan menampilkan jendela Buat Versi Dokumentasi Baru.

3. Pilih Tipe Versi sesuai kebutuhan perubahan:

   • Major: Digunakan untuk perubahan besar atau breaking changes.
   • Minor: Digunakan untuk penambahan fitur atau pembaruan signifikan.
   • Patch: Digunakan untuk perbaikan kecil seperti typo atau koreksi minor.
   • Custom: Digunakan jika ingin menentukan nomor versi secara manual.

4. Sistem akan menampilkan nomor versi baru yang akan dibuat.

5. Isi kolom Change Log dengan deskripsi perubahan yang dilakukan pada versi tersebut.

6. (Opsional) Isi Catatan Tambahan jika terdapat informasi tambahan terkait perubahan versi.

7. Setelah semua informasi terisi dengan benar, klik Buat Versi untuk membuat versi dokumentasi baru.

Publish Versi

Setelah seluruh dokumentasi pada BPMN selesai dibuat dan diperiksa, versi dokumentasi dapat dipublikasikan agar menjadi versi resmi yang digunakan.

1. Pastikan seluruh dokumentasi pada BPMN telah diisi dan disimpan dengan lengkap.

2. Klik tombol Publish pada halaman Documentation Manager.

   

3. Sistem akan menampilkan jendela konfirmasi Publish Versi.

   

4. Klik tombol Publish untuk mengonfirmasi proses publikasi versi.

Setelah proses publish berhasil:

• Sistem akan menampilkan notifikasi “Versi berhasil dipublish”.
• Versi dokumentasi tersebut akan menjadi versi resmi (Published Version).
• Versi yang telah dipublish tidak dapat diedit kembali.
• Versi sebelumnya akan berubah status menjadi Superseded.

Dengan melakukan publish, dokumentasi BPMN dapat digunakan sebagai referensi resmi untuk proses bisnis yang dijalankan.

Preview Dokumentasi

Fitur Preview Documentation digunakan untuk melihat tampilan akhir dokumentasi BPMN dalam bentuk dokumen SOP sebelum dicetak atau diekspor.

1. Pada halaman Documentation Manager, klik tab Preview All Documentation.

   

2. Sistem akan menampilkan halaman Documentation Preview yang berisi dokumen SOP berdasarkan dokumentasi BPMN yang telah dibuat.

   

3. Gunakan tombol Fullscreen untuk melihat dokumen dalam tampilan layar penuh.

4. Klik tombol Print jika ingin mencetak dokumen dokumentasi.

5. Klik tombol Export untuk mengunduh dokumentasi dalam format dokumen. Dokumentasi dapat diekspor dalam format PDF dan Word.

6. Klik Exit Fullscreen untuk kembali ke tampilan sebelumnya.

Dengan fitur ini, pengguna dapat meninjau hasil dokumentasi BPMN secara keseluruhan sebelum digunakan atau didistribusikan.