Tips Berguna

Bagaimana cara saya mendokumentasikan proses pengembangan

Pin
Send
Share
Send
Send


Perusahaan sering mendokumentasikan prosesnya sehingga setiap karyawan tahu bagaimana melakukannya dengan benar, atau menganalisis proses untuk memperbaikinya. Jika Anda diminta untuk mendokumentasikan proses atau Anda sendiri yang memutuskan untuk melakukan ini, pastikan untuk melibatkan orang-orang yang cukup berpengalaman dan kompeten dalam proses secara keseluruhan. Dua jenis presentasi grafis dijelaskan di bawah ini, tetapi jika Anda berpikir bahwa proses Anda lebih cocok untuk diagram sederhana dari jenis lain atau dokumen teks, Anda dapat menggunakan versi Anda sendiri. Dalam hal ini, baca bagian kiat umum untuk mendapatkan gambaran tentang tujuan dokumentasi proses.

Diskusi

Saya memperbaiki hasil semua negosiasi. Butuh satu menit, tetapi memungkinkan Anda untuk menjawab pertanyaan seperti: "Mengapa kita membutuhkan ini?", "Mengapa kita tidak membutuhkannya sekarang?" Kelompok pertanyaan pertama mungkin muncul dengan tiang tembok di bagian analitis atau karena kembali ke beberapa fungsi lama. Kelompok pertanyaan kedua memungkinkan Anda membuat keputusan dengan lebih percaya diri pada titik balik.

Di github, saya membuat halaman notulen rapat tentang wiki tempat saya mencatat hasil diskusi dalam urutan kronologis. Saya menunjukkan tanggal dan subjek diskusi dalam judul. Saya segera menulis di github. Jadi saya punya satu halaman dengan hasil semua diskusi. Jika diskusi adalah teks di Skype, maka di Skype saya menulis satu pesan yang saya edit dan minta konfirmasi. Saya menyalin ke github bersama dengan konfirmasi. Volume rekaman rata-rata untuk satu diskusi adalah 5-10 baris.

Persyaratan

Ini agak sulit. Saya komit: antarmuka pengguna, area subjek, teks persyaratan untuk setiap iterasi.

Antarmuka pengguna - Saya menggunakan AxureRP. Saya mendokumentasikan secara detail - hingga tombol, menambahkan dinamika transisi halaman, memperbarui bagian halaman. Ini membantu banyak untuk mempercepat pengiriman tugas kepada pengembang, untuk mengidentifikasi kesalahan mereka sendiri dalam merancang solusi untuk skenario pengguna yang tepat. Saya menerbitkan antarmuka untuk berbagi dan menggunakan tautan ke halaman yang diperlukan dalam persyaratan dan diskusi. Sangat nyaman Saya memperbarui antarmuka segera setelah setiap perubahan.

Ini adalah prototipe antarmuka saya yang paling umum:

Bidang subjek - Saya menggunakan Enterprise Architect hanya sebagai gambar diagram ER. Tahap ini sangat penting bagi saya, karena di atasnya saya menangkap banyak saran untuk mengubah implementasi yang diusulkan, yang akan memungkinkan saya untuk mendapatkan keuntungan tertentu di masa depan, saya memikirkan struktur penyimpanan data, dll. Dalam proyek yang sangat kecil, saya sering menghilangkan komponen ini. Saya menerbitkan gambar-gambar diagram yang dihasilkan bersama dengan prototipe axshare dan juga memberi mereka tautan dalam tugas iterasi atau dalam diskusi di Skype sehingga pengembang lebih memahami tugas atau untuk secara substansial mendiskusikan masalah tersebut dengan orang yang tertarik. Juga sangat mudah langsung dari antarmuka pengguna prototipe untuk menyediakan tautan ke diagram sehingga pengembang tidak kehilangan konteks saat membaca persyaratan.

Persyaratan - Saya segera menulis di github. Pada github di wiki, buat halaman terpisah, yang berisi urutan kronologis semua perubahan (masing-masing semua iterasi). Saya menggunakan tautan ke prototipe dan diagram domain. Saya hanya menjelaskan logika. Jika Anda menulis lebih banyak dan lebih detail, maka biaya pemeliharaan dokumentasi meningkat tajam. Volume rata-rata 4-5 paragraf 1-10 baris. Iterasi biasanya 3-10 hari.

Pendekatan ini memungkinkan satu halaman melihat seluruh kronologi iterasi dan analitik dan pengembang. Juga, yang sangat penting, saya menggunakan halaman yang sama untuk merekam rencana untuk iterasi berikutnya. Saya menyoroti iterasi saat ini dengan warna atau hanya teks tebal. Terkadang saya menunjukkan tanggal fakta / rencana tanggal mulai dan berakhirnya iterasi. Semakin jauh iterasi yang direncanakan dari saat ini, semakin abstrak presentasi, semakin dekat semakin detail. Saya menggunakan deskripsi iterasi masa depan untuk diskusi dengan pengembang dan peserta lain dalam proses.

Contoh khas persyaratan iterasi:

Saya menghitung bahwa rata-rata dibutuhkan 2-3 jam untuk mendokumentasikan persyaratan untuk iterasi (rata-rata seminggu sekali): 1 jam untuk area subjek, 1 untuk desain antarmuka dan hingga 1 jam untuk deskripsi tekstual dari persyaratan.

Perubahan mengidentifikasi dua jenis: bug dan enchencement. Sebagai pelacak, saya menggunakan github yang sama. Seiring waktu, saya sampai pada serangkaian label tugas berikut:

Dan aturan berikut untuk membubuhkan status:

Ciptaan. Analis melakukan tugas (bug atau peningkatan), secara opsional menunjukkan jika kesalahan ada di medan perang dan pada tes itu bukan (prod), dan secara opsional menunjukkan jika koreksi perlu segera (A).

Bekerja Pengembang memeriksa untuk melihat apakah ada tugas dengan label (A). Jika ada yang mengambilnya, jika tidak membawanya berikutnya. Ia membaca dan mengoreksi (perlu diunggah), atau mengatakan bahwa itu tidak dapat mereproduksi (tidak dapat mereproduksi), atau memerlukan informasi lebih lanjut (butuh info).

Informasi Jika diperlukan suatu reaksi, Analis menjawab dalam komentar dan menghapus (tidak dapat mereproduksi / membutuhkan info) atau menutup tugas.

Bekerja Pengembang memperbaiki jika tugas tersebut tidak dihapus dan ditetapkan (perlu diunggah).

Isi tes Pengembang mencurahkan, menghapus kebutuhan uplaod, menetapkan tetap apa yang diunggah ke server uji. Jika bug ditentukan dari yang satu, maka Pengembang tidak mengaturnya sampai ada perubahan pada yang satu.

Uji verifikasi Penguji melihat dan menutup tugas, atau membiarkannya terbuka dan menghapus tetap.

Isi pertempuran Pengembang mengunggah ke pertempuran: - semua yang tertutup yang diperbaiki (pada saat yang sama menghapus tetap) - semua yang terbuka yang memiliki (prod) dan (perlu diunggah).

Periksa pertempuran Penguji menguji bug-bug yang (prod) dan (diperbaiki), jika semuanya OK, lalu tutup tugas.

* Saya memiliki nama asli pengembang dan peserta proses lainnya di wiki. Ini membantu.

Kesimpulan

Saya datang ke format pekerjaan ini selama beberapa tahun bekerja sebagai analis / manajer proyek, bekerja pada proyek otomatisasi untuk perusahaan kecil dan layanan Internet konvensional. Hal di atas mungkin basi, tetapi ini benar-benar menghemat waktu, memungkinkan seluruh tim mengikuti perkembangan acara dan tidak kehilangan waktu mendukung dokumen tambahan.

Menerima Dokumen

Tentu saja, untuk menerima dokumen, mereka harus diminta terlebih dahulu. Tetapi kata-kata dari pertanyaan dari seri "Tolong beri saya semua dokumen pada proses" tidak mungkin untuk menemukan pemahaman. Karena itu, kata-kata dalam permintaan itu penting. Permintaan, tentu saja, konsep bersyarat. Anda dapat "meminta" dokumen secara tertulis, atau Anda dapat secara lisan. Tetapi bagaimanapun juga, Anda harus menjelaskan dokumen spesifik apa yang Anda butuhkan. Terlepas dari kenyataan bahwa kumpulan dokumen berbeda dari perusahaan ke perusahaan, ia memiliki struktur dan konsep umum tertentu.

Itu penting. Terlepas dari kenyataan bahwa Anda dapat meminta dokumen hanya selama percakapan, saya sarankan bahwa pada akhir percakapan, duplikat permintaan melalui surat. Surat itu harus menunjukkan dengan tepat dokumen mana yang ingin Anda terima dan kapan. Dengan demikian, Anda akan memberikan kesempatan untuk mempertimbangkan permintaan Anda dan dengan tenang mengumpulkan dokumentasi yang diperlukan.

1. Dokumen manajemen

  • peraturan - Dokumen utama dari proses, di mana semua informasi tentang proses ditunjukkan. Saya akan mempertimbangkan struktur regulasi secara terpisah, tetapi secara teori peraturan tersebut mencakup segala hal yang perlu Anda ketahui tentang proses - dari model proses dan pesertanya hingga indikator kinerja utama.
  • instruksi - Penjelasan rinci selangkah demi selangkah mengenai eksekusi suatu subproses. Tidak masuk akal untuk mengungkapkan subproses tersebut secara rinci dalam model. Alasan untuk ini adalah bahwa subprosesnya linier, mis. satu tindakan sederhana dilakukan secara berurutan. Misalnya, instruksi untuk mendaftarkan kotak surat.
  • naskah - pada kenyataannya, skrip menampilkan pohon tindakan, semua cabang skrip. Sebagai aturan, konsep "skrip" digunakan di bidang TI dan mencerminkan perilaku sistem dalam skenario tertentu. Tetapi mereka juga menyebut pohon pengembangan percakapan, misalnya, dengan klien. Skrip seperti itu mencerminkan frasa yang disukai tergantung pada reaksi klien.
  • prosedurnya - untuk sebagian besar dokumen tambahan yang menggambarkan salah satu subproses. Ekstra karena uraian dari subproses harus dimasukkan dalam model umum dari proses bisnis. Seluruh dokumen dapat diganti dengan diagram proses tunggal sebagai bagian dari model dan regulasi.

2. Memproses dokumen

Dokumen tersebut adalah semua dokumen yang muncul langsung dalam proses. Misalnya, dalam proses "Penjualan", dokumen "penerimaan kas" muncul. Atau contoh lain, di mana dokumen tidak melampaui ruang lingkup proses - dalam proses "Penjualan" yang sama, di samping tanda terima uang tunai, "catatan dalam jurnal penjualan" dibuat. Saat meminta, buat catatan bahwa Anda membutuhkan sampel nyata dari dokumen tersebut. Jika dokumen tersebut merupakan bagian dari sistem informasi, mintalah akses ke sistem dan tautan ke dokumen tertentu. Dalam keadaan darurat, minta tangkapan layar.

Itu penting. Secara umum, istilah "dokumen" tidak berarti adanya "selembar kertas" yang terpisah. Entri jurnal adalah dokumen. Aplikasi atau formulir elektronik juga merupakan dokumen. Bahkan email adalah dokumen dalam hal manajemen proses bisnis. Dengan kata lain, dokumen adalah informasi yang memiliki bentuk tertentu - kertas, elektronik, cairan, gas atau lainnya ... hanya bercanda))

3. Dokumen fungsional

  • deskripsi pekerjaan - berisi uraian tentang hak dan tanggung jawab fungsional karyawan yang dapat dikaitkan dengan proses bisnis.
  • politik, posisi - dokumen dengan orientasi umum, namun informasi yang berguna dapat diperoleh dari mereka. Misalnya, jika Anda terlibat dalam proses "Manajemen Mutu", Anda mungkin memerlukan "Kebijakan Mutu" dan / atau "Peraturan tentang Departemen Kontrol Kualitas"

Pemrosesan dokumen

Berbicara tentang pemrosesan dokumen, maksud saya menertibkan, membangun hubungan antara dokumen dan menemukan informasi yang diperlukan.
Hal pertama yang harus dilakukan adalah sederhana mendistribusikan dokumen melalui proses. Jika satu dokumen, misalnya, deskripsi pekerjaan menyangkut beberapa proses, maka itu harus disalin ke folder setiap proses, atau, jika dokumen itu dalam bentuk kertas, buat catatan tentang proses yang dimaksud. Yang terbaik dari semua stiker.

Distribusi dokumen berdasarkan proses

Berikut ini. Kebutuhan melihat dokumen dan mengidentifikasi hubungan di antara mereka. Hubungan antara dokumen - ketika dalam satu dokumen ada referensi langsung atau tidak langsung ke dokumen lain. Dengan tautan langsung, semuanya jelas. Referensi tidak langsung adalah ketika dokumen tersirat, tetapi tidak ditentukan. Misalnya, seringkali mungkin untuk memenuhi kata-kata "Diindikasikan pada posisi yang relevan". “Ketentuan terkait” adalah referensi tidak langsung. Struktur dokumen harus kira-kira berbentuk sebagai berikut:

Hubungan Dokumen

Itu penting. Jika Anda tidak memiliki dokumen, tetapi tersirat dalam sistem, atau Anda memahami bahwa itu harus secara logis, maka buat catatan yang sesuai dalam struktur.

Sekarang dibutuhkanpelajarilah setiap dokumen dengan cermat. Tujuan dari penelitian ini adalah untuk menemukan semua informasi yang berkaitan dengan proses dan benar-benar membuat sketsa model. Untuk membuat sketsa, Anda perlu mencari informasi yang akan menjawab pertanyaan-pertanyaan berikut:

  • Siapa yang terlibat dalam proses ini?
  • Apa yang dilakukan masing-masing peserta dalam proses?
  • Operasi spesifik apa yang dilakukan dan dalam urutan apa?
  • Di mana prosesnya dimulai?
  • Apa hasil dari proses ini?
  • Apa yang digunakan untuk mengimplementasikan proses dan dalam jumlah berapa? - alat, program, persediaan, uang, dan sumber daya lainnya.
  • Dokumen apa yang digunakan proses?
  • Dokumen apa yang muncul dalam proses?
  • Siapa yang menggunakan produk proses?
  • Siapa yang menentukan awal dan pelaksanaan proses?
  • Indikator apa yang dilacak?
  • Siapa dan bagaimana mengontrol proses?

Tentu saja, yang paling penting saat ini adalah pemahaman tentang apa yang subproses dan operasi proses bisnis terdiri dari dan dalam urutan apa mereka dilakukan. Mulai untuk menarik utas ini, Anda akan menguraikan seluruh bola.

Saat memproses dokumen, tandai semua informasi yang relevan agar dapat dengan cepat menemukan bagian yang diperlukan. Saya lebih suka menyusun struktur dalam bentuk kartu intelijen dan memasukkan semua catatan dan pertanyaan yang diperlukan di sana.

Contoh pemrosesan dan penataan dokumen

Berbicara tentang pertanyaan. Jangan mencoba menganalisis dokumen dan segera menulis pertanyaan di margin. Pelajari dokumen terlebih dahulu dan baru kemudian merumuskan pertanyaan. Dengan demikian, selamatkan diri Anda dari pekerjaan yang tidak perlu.

Jika benar-benar ada sejumlah besar dokumen, yang terbaik adalah menetapkan kode untuk setiap dokumen dan sepotong informasi, dan kemudian membuat database. Harap dicatat bahwa Anda harus kembali ke banyak bagian dalam dokumen lebih dari satu kali. Oleh karena itu, saya lebih suka mentransfer semua informasi yang relevan dari dokumen ke struktur yang dibuat. Jadi, saya dapat bekerja hanya dengan menggunakan satu dokumen.

Berinvestasi dalam tabungan waktu mendatang selalu terbayar.

Analisis Dokumen

Hanya setelah Anda mempelajari dokumen dengan cermat, menyusunnya, meletakkannya di rak dan memilih semua informasi penting, Anda dapat memulai analisis. Tujuan dari analisis ini adalah untuk menyiapkan daftar pertanyaan untuk tahap pekerjaan selanjutnya, khususnya, melakukan wawancara.
Jika Anda telah melewati semua langkah sebelumnya untuk memproses dokumen, Anda harus siap membantu:

  1. Struktur dokumen
  2. Peras informasi dan catatan kepada mereka.
  3. Model proses bisnis berdasarkan informasi dari dokumen.

Titik awal untuk analisis adalah model proses bisnis.

Representasi grafis baik hanya karena segera memberikan gambaran tentang informasi yang hilang. Kemungkinan besar, model yang diperoleh berdasarkan informasi dari dokumen akan kesenjangan dengan lubang logis. Ini berarti bahwa dengan mengajukan pertanyaan "Apa yang terjadi selanjutnya?" Sehubungan dengan situs proses, Anda tidak dapat menemukan jawabannya di dokumen. Misalnya, Anda sering dapat menemukan kata-kata seperti itu - kirim laporan ke kepala. Formulasi ini jelas menunjukkan "lubang logis". Tidak jelas cara mengirim, kapan, ke manajer mana dan, yang paling penting, apa yang terjadi setelah itu.

Jadi Langkah pertama adalah menganalisis model proses bisnis untuk kesenjangan logis.
Istirahat yang logis adalah ketika Anda tidak dapat menemukan jawaban untuk pertanyaan "Apa yang terjadi selanjutnya?"
Setiap celah harus dicatat dan ditandai ke bagian, sub-proses atau prosedur yang menjadi bagiannya.

Hal selanjutnya yang perlu diperiksa adalah awal dan hasil proses yang jelas. Penting untuk memahami dengan jelas bagaimana dan dalam kondisi apa segala sesuatu dimulai dan bagaimana akhirnya. Sama pentingnya untuk memahami siapa yang menggunakan produk dari proses di masa depan dan kepada siapa awal dari proses tersebut bergantung.

Selanjutnya Peserta dalam proses. Anda perlu memeriksa siapa yang melakukan operasi tertentu dari proses tersebut. Dalam model proses bisnis, tidak mungkin ada subproses atau operasi yang, seolah-olah, dilakukan, tetapi tidak jelas oleh siapa. Sebenarnya, ini biasa terjadi.

Memproses dokumen. Untuk setiap dokumen proses, Anda perlu mencari tahu:

  • Dari mana dokumen ini berasal?
  • Apa dan siapa yang melakukannya dalam proses?
  • Bagaimana dokumen berubah, informasi apa yang diperkenalkan atau digunakan darinya?
  • Apa yang terjadi pada dokumen ketika telah menyelesaikan fungsinya?

Jika Anda tidak dapat menemukan jawaban untuk pertanyaan-pertanyaan ini, tuliskan dan klarifikasi di masa mendatang.

Indikator kinerja. Anda perlu memahami indikator apa, di mana, dan bagaimana cara memperbaiki dalam proses. Apa yang terjadi selanjutnya dengan indikator-indikator ini, siapa yang bertanggung jawab atas pengumpulan, analisis, dan ke mana analisis ini melangkah lebih jauh.

Infrastruktur Tuliskan semua pertanyaan tentang alat, perangkat lunak, persediaan, uang tunai, dll. - semua yang dapat dikaitkan dengan sumber daya dari proses bisnis. Anda harus memahami siapa, dalam kasus apa dan sejauh mana menggunakan sumber daya ini atau itu.

Semua pertanyaan pada poin-poin di atas harus ditulis, referensi ke dokumen yang diproses harus dibuat untuk mereka.

Setelah dengan hati-hati memproses dokumentasi, Anda dapat melanjutkan ke tahap berikutnya - melakukan wawancara.

Tonton videonya: Begini Proses Pembangunan Jalan Trans Papua Yang dibuat TNI dari Awal Sampai Diaspal (Agustus 2020).

Pin
Send
Share
Send
Send