Templat dokumentasi

Setiap dokumen yang dibuat mengikuti templat dokumen. Di aplikasi, templat ini disebut Templat dokumen. Templat menentukan bagian yang dimuat dalam dokumen dan urutannya: halaman judul, daftar isi, bab dan bagian, blok teks, kolom dokumentasi, model, matriks RACI, dokumentasi elemen, diagram, serta penetapan RACI untuk setiap aktivitas.

Setiap tingkat arsitektur memiliki templat sendiri. Dengan begitu, ringkasan proses, SOP terperinci, dan paket audit dapat menjelaskan proses yang sama dengan cara berbeda.

Lokasi templat

• Pengaturan → Arsitektur proses menampilkan setiap tingkat sebagai kartu. Buka label Templat dokumen pada tingkat tersebut, atau klik ikon edit untuk membuka editor.
• Di tab Dokumentasi, pemilih Templat dokumen di panel samping digunakan untuk beralih ke dokumen lain. Templat default tingkat tersebut digunakan sampai seseorang memilih templat lain.
• Editor dapat membuka templat langsung dari dokumen: buka menu ekspor, lalu pilih Edit templat….

Templat diatur di Arsitektur proses. Siapa pun yang dapat membaca dokumentasi suatu proses akan melihat dokumen yang dihasilkan templatnya. Setiap ekspor menggunakan templat yang dipilih di halaman dokumentasi.

Memilih dan mengelola templat

Editor berupa satu dialog: pemilih templat dan tombol tambah ada di bagian atas, pohon dokumen di kiri, dan pengaturan simpul yang dipilih di kanan. Bagian bawah memuat Batal dan Simpan.

Editor terbuka pada templat yang terakhir Anda edit untuk tingkat tersebut. Edit templat… di halaman dokumentasi akan membuka templat yang digunakan dokumen saat ini.

• Pemilih Templat dokumen di bagian atas digunakan untuk beralih di antara templat pada tingkat tersebut. Entri berlabel Draf tidak terlihat oleh pengguna portal. Label Default menandai templat yang dibuka di halaman dokumentasi.
• + menambahkan templat bernama Templat dokumen baru dan memilihnya.
• Nama mengganti nama templat yang dipilih.
• Diterbitkan mengatur apakah pengguna portal dapat memilih templat di halaman dokumentasi. Editor selalu dapat melihat draf.
• Jadikan default menjadikan templat yang dipilih sebagai templat yang digunakan halaman dokumentasi jika tidak ada templat lain yang dipilih. Setiap tingkat memiliki satu templat default.
• Hapus templat dokumen menghapus templat yang dipilih. Anda tidak dapat menghapus satu-satunya templat default pada suatu tingkat. Tetapkan templat lain sebagai default terlebih dahulu.
• Sertakan elemen tanpa dokumentasi menambahkan elemen model yang belum memiliki deskripsi ke bagian elemen dalam dokumen. Nonaktifkan opsi ini jika dokumen hanya perlu memuat dokumentasi yang sudah selesai.

Penambahan dan penghapusan templat, serta penetapan templat default, langsung diterapkan. Nama, visibilitas, opsi konten, halaman judul, dan pohon dokumen disimpan saat Anda memilih Simpan.

Menyusun dokumen

Sisi kiri editor menampilkan pohon dokumen. Seret simpul untuk mengubah urutannya, atau letakkan pada bab atau bagian untuk menjadikannya bagian di dalamnya. Gunakan tombol menu pada baris atau klik kanan baris untuk menambah dan menghapus konten.

Bab dan bagian

• Tambahkan bab di bawah menambahkan bab di tingkat teratas dokumen.
• Tambahkan bagian atau Tambahkan bagian di bawah menambahkan bagian bertingkat atau sejajar.
• Pilih bab atau bagian untuk mengedit Judul dan mengaktifkan atau menonaktifkan Penomoran otomatis. Penomoran mengikuti susunan pohon: bab menggunakan X, bagiannya X.Y, dan bagian yang lebih dalam X.Y.Z. Panel menampilkan tingkat judul yang digunakan simpul.
• Hapus menghapus simpul yang dipilih beserta semua simpul di bawahnya.

Simpul konten

Menu simpul menyediakan opsi berikut:

• Tambahkan teks / Tambahkan teks di bawah menambahkan blok Markdown. Tulis judul, daftar, tautan, atau catatan di kolom Teks Markdown. Placeholder juga dapat digunakan di sini.
• Tambahkan kolom dokumentasi… / Tambahkan kolom dokumentasi di bawah… menambahkan salah satu kolom dokumentasi yang diterbitkan untuk tingkat tersebut. Jika kolom kemudian tidak lagi diterbitkan, kolom itu dihapus dari dokumen. Jadi, dokumen tidak akan menampilkan konten yang tidak lagi diterbitkan pada tingkat tersebut.
• Tambahkan model / Tambahkan model di bawah menampilkan diagram proses. Tampilkan data menambahkan ringkasan “Filter & Data yang digunakan” di bawah diagram.
• Tambahkan RACI / Tambahkan RACI di bawah menampilkan matriks RACI.
• Tambahkan elemen / Tambahkan elemen di bawah menampilkan dokumentasi setiap elemen model.
• Tambahkan bagian diagram menempatkan dokumentasi diagram pada posisi tersebut di dokumen. Opsi ini dapat digunakan di tingkat teratas atau di dalam bab maupun bagian.
• Tambahkan RACI aktivitas individual menambahkan penetapan RACI untuk setiap aktivitas di bagian elemen. Jika ditambahkan di tingkat teratas, opsi ini berlaku untuk seluruh dokumen.

Tambahkan halaman judul dan Tambahkan daftar isi hanya tersedia di tingkat teratas, masing-masing satu kali. Keduanya berupa simpul. Pilih simpul untuk mengeditnya, atau hapus jika dokumen tidak memerlukan halaman judul atau daftar isi.

Halaman judul

Pilih simpul halaman judul untuk mengatur:

• Unggah gambar, Ganti, atau ikon hapus untuk mengatur gambar latar.
• Judul, yang secara default menggunakan nama proses. Gunakan placeholder agar judul mengikuti proses.
• Subjudul untuk mencantumkan versi, klasifikasi, atau audiens.

Placeholder

Teks yang dapat diedit mendukung placeholder. ProcessMind akan mengisinya saat membuat dokumen:

{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}

Klik chip placeholder untuk menyalinnya, atau klik dua kali untuk menambahkannya ke teks yang sedang diedit. Jika suatu proses tidak memiliki nilai untuk placeholder, hasilnya berupa teks kosong.

Templat dan ekspor

Templat menentukan isi dokumen. Ekspor PDF, Word, Markdown, dan cetak semuanya mengikuti templat yang dipilih. Konten yang tidak ada dalam templat tidak akan disertakan dalam ekspor. Untuk menyembunyikan bagian tertentu pada satu templat, hapus simpulnya. Untuk menggunakan beberapa gaya dokumen pada satu tingkat proses, buat satu templat untuk setiap gaya dan jadikan templat yang ingin dibuka di halaman dokumentasi sebagai default.

Topik terkait

• Editor dokumentasi
• Mengekspor dokumentasi
• Arsitektur proses
• Tingkat arsitektur