Cara mendokumentasikan proses perangkat lunak secara otomatis

Menulis dokumentasi proses secara manual adalah salah satu tugas yang tim tahu harus dilakukan, namun jarang sempat dikerjakan. Tugas ini membutuhkan waktu, fokus, dan pemahaman yang cukup mengenai proses tersebut agar dapat ditulis dengan akurat. Saat seseorang akhirnya duduk untuk menulis SOP bagi alur kerja yang mereka lakukan setiap hari, mereka sering kali sudah lupa detailnya.

Alternatifnya: rekam diri Anda saat melakukan proses tersebut, dan biarkan AI mengubah rekaman itu menjadi dokumentasi. Berikut cara mengaturnya.

Seperti apa bentuk dokumentasi proses otomatis#

Dokumentasi proses otomatis bukan berarti AI menebak-nebak proses Anda. Artinya, AI mengamati apa yang sebenarnya Anda lakukan di layar dan mendokumentasikannya dengan tepat.

Anda menjalankan proses di produk, CRM, alat internal, atau perangkat lunak apa pun yang berjalan di mesin Mac atau Windows Anda. Rekaman tersebut menangkap setiap klik, ketukan tombol, dan status layar. AI menganalisis data terstruktur tersebut dan menghasilkan dokumentasi yang mencerminkan apa yang Anda lakukan, dalam urutan yang benar, dengan terminologi yang tepat.

Hasilnya bukanlah transkrip. Ini adalah panduan tertulis langkah demi langkah dengan langkah bernomor, tangkapan layar yang ditempatkan di titik yang tepat, judul bagian untuk setiap fase proses, dan video tutorial tertanam yang menunjukkan proses tersebut saat berjalan.

Itulah perbedaan antara cara ini dengan alat yang mungkin sudah Anda gunakan. Notion dan Confluence adalah tempat yang baik untuk menyimpan dokumentasi, tetapi mereka tidak menulisnya. Loom menangkap video dan membiarkan Anda membuat panduan tertulisnya sendiri. Alat dokumentasi proses yang bekerja dari rekaman menghasilkan keduanya.

Langkah demi langkah: mendokumentasikan proses perangkat lunak dengan Clevera#

Langkah 1: Buka Clevera dan mulai merekam\nLuncurkan aplikasi desktop Clevera di Mac (macOS 12.3 atau lebih baru) atau Windows (10 Build 20348 atau lebih baru). Klik rekam sebelum Anda memulai proses. Sudah punya rekaman prosesnya? Unggah saja.

Langkah 2: Lakukan prosesnya seperti biasa\nJalankan alur kerja dengan kecepatan normal. Klik menu, isi kolom, navigasikan antar layar. Anda tidak perlu melambat atau menjelaskan apa pun saat melakukannya. Clevera menangkap semuanya.

Langkah 3: Berhenti merekam saat proses selesai\nKlik berhenti. Clevera mengirimkan data rekaman, termasuk interaksi layar, gerakan mouse, dan konteks aplikasi, ke alur pemrosesan AI-nya.

Langkah 4: Tinjau dokumentasi yang dihasilkan AI\nDalam beberapa menit, Clevera menghasilkan dua output:

• Video tutorial naratif dengan sulih suara buatan AI yang disinkronkan ke setiap langkah
• Panduan tertulis terstruktur dengan langkah bernomor, tangkapan layar yang dipilih otomatis, dan judul bagian

Tinjau keduanya di editor Clevera. Video diputar di editor linimasa. Artikel terbuka di editor blok bergaya Notion.

Langkah 5: Edit jika diperlukan\nDokumentasi yang dihasilkan biasanya akurat, tetapi Anda tetap perlu meninjaunya. Tambahkan catatan tentang kesalahan umum di langkah 4. Ubah kalimat langkah yang sedikit ambigu. Minta AI untuk menambahkan peringatan untuk tindakan yang bersifat merusak. Pengeditan ini hanya memakan waktu beberapa menit.

Langkah 6: Publikasikan\nPublikasikan ke pusat bantuan Clevera Anda, ekspor ke Markdown atau HTML, atau, pada paket Pro ke atas, publikasikan langsung ke Notion, Confluence, GitHub, Help Scout Docs, dan platform lainnya. Video akan tertanam di bagian atas artikel.

Jenis proses perangkat lunak apa yang paling cocok untuk ini#

Alur kerja multi-langkah dalam produk SaaS. Menyiapkan integrasi, mengonfigurasi izin pengguna, membuat dan menerbitkan konten, menjalankan laporan. Apa pun yang melibatkan urutan langkah dalam UI.

Proses Admin dan IT. Menyediakan akun pengguna, mengonfigurasi pengaturan sistem, melakukan tugas pemeliharaan. Proses ini sering kali kurang terdokumentasi karena hanya dilakukan sesekali, menjadikannya jenis proses yang paling diuntungkan dari dokumentasi.

Alur orientasi pelanggan. Dokumentasikan langkah-langkah yang perlu diambil pelanggan baru untuk mendapatkan nilai dari produk Anda. Jaga agar dokumentasi tetap terkini dengan merekam ulang saat alur berubah.

Proses tim internal. Alur kerja HR, persetujuan keuangan, proses penjualan di CRM Anda. Setiap proses berbasis perangkat lunak yang perlu dipelajari oleh anggota tim baru.

Menjaga dokumentasi proses otomatis tetap terkini#

Keuntungan terbesar dari dokumentasi berbasis rekaman bukan hanya pembuatan awalnya. Namun, betapa mudahnya proses pembaruan dilakukan.

Dengan dokumentasi tradisional, memperbarui berarti membuka artikel, menemukan langkah yang berubah, menulis ulang, mengambil tangkapan layar baru, mengganti yang lama, dan menerbitkan kembali. Dengan Clevera, memperbarui berarti merekam ulang langkah yang berubah—yang hanya memakan waktu beberapa menit—lalu menghasilkan dokumentasi baru dan menerbitkannya.

Fitur LiveSync Clevera menangani distribusinya. Video yang diperbarui akan muncul di mana pun video tersebut disematkan, tanpa perlu penggantian file manual. Jika tidak ada perubahan di layar, misalnya hanya catatan kebijakan atau konteks tambahan, Anda dapat mengedit narasi dan teks artikel tanpa perlu merekam ulang.

Hal ini membuat SOP dan panduan proses Anda tetap relevan dengan setiap pembaruan produk, bukan hanya pembaruan besar saja.

Mengapa merekam lebih baik daripada menulis untuk dokumentasi proses#

Menulis proses dari ingatan lebih lambat dan kurang akurat daripada merekamnya. Anda akan melupakan satu langkah. Anda akan melewatkan langkah yang tampak jelas. Anda akan menggunakan terminologi yang sedikit berbeda dari apa yang muncul di layar.

Rekaman menangkap apa yang sebenarnya terjadi. Dokumentasi proses otomatis yang dibuat dari rekaman lebih akurat daripada dokumen yang ditulis secara manual karena tidak bergantung pada ingatan atau interpretasi siapa pun.

Hal yang sama berlaku saat meminta chat AI umum untuk menulis SOP. AI tersebut menulis berdasarkan deskripsi Anda, termasuk langkah-langkah yang Anda lewatkan karena dianggap sudah jelas. Padahal, justru langkah-langkah itulah yang membuat karyawan baru sering mengalami kendala.

Apa yang harus dicari dalam alat dokumentasi proses#

• Belajar dari layar Anda, bukan deskripsi Anda. Menangkap layar lebih baik daripada mengetik langkah-langkah.
• Output terstruktur. Langkah bernomor dengan tangkapan layar, bukan transkrip atau tumpukan paragraf.
• Video dan panduan tertulis dari satu rekaman. Beberapa orang lebih suka menonton, yang lain lebih suka membaca; membuat keduanya secara terpisah akan menggandakan pekerjaan.
• Pengeditan nyata. Anda perlu menambahkan peringatan, mengubah kalimat langkah, dan memperbaiki istilah di editor yang tepat.
• Publikasi ke tempat tim Anda membaca. Periksa platform mana saja yang didukung untuk publikasi, dan pada paket apa.
• Jalur pembaruan yang cepat. Saat proses berubah, memperbarui panduan seharusnya memakan waktu sama dengan saat merekamnya pertama kali, tidak lebih lama.

Bagi tim yang ingin membangun alur kerja AI SOP generator lengkap, termasuk kontrol versi, tinjauan tim, dan publikasi multi-bahasa, pilar tersebut mencakup gambaran menyeluruh. Untuk informasi lebih lanjut tentang best AI SOP software yang tersedia saat ini, rangkuman tersebut membandingkan opsi-opsi utama.

Mulailah dengan proses yang paling sering ditanyakan kepada tim Anda. Rekam sekali. Biarkan Clevera mendokumentasikannya. Publikasikan sebelum hari berakhir.