Proyek Dokumentasi yang Sukses

Proyek Dokumentasi yang Sukses – Bagian 1 dari 3 – “Memahami” . Jasa Multimedia adalah jasa yang bergerak dibidang gambar dan video. Dengan fitur edit yang tidak membosankan dan keren. Anda bisa bisa konsultasi dahulu sebelum proses edit di laksanakan.

penciptaan dokumentasi pengguna adalah komponen besar dari setiap proyek perangkat lunak. Sayangnya, sering kali undervalued dan dibiarkan hingga menit terakhir. Tetapi itu tidak berarti itu harus tanpa rencana manajemen yang baik.

Ini adalah yang pertama dalam serangkaian tiga artikel yang menguraikan elemen-elemen kunci dari proses dokumentasi pengguna yang baik. Ini semacam proses “ideal”; sangat sedikit proyek akan dapat menerapkan setiap langkah, dan beberapa akan memerlukan langkah tambahan. Meskipun demikian, ini harus memberi Anda landasan yang baik (terutama jika Anda baru dalam pengelolaan dokumentasi pengguna).

Proyek Dokumentasi yang Sukses

Berikut ikhtisar dari tiga artikel tersebut.

Artikel 1 (artikel ini) – Mengerti

– Identifikasi ruang lingkup Anda
– Biasakan diri Anda dengan lingkungan kerja
– Biasakan diri Anda dengan produk ini
– Identifikasi audiens untuk dokumentasi
– Tentukan kebutuhan audiens yang dirasakan
– Kira-kira memperkirakan durasi dan sumber daya proyek doko
– Persyaratan audiens penelitian

Pasal 2 – Tentukan (Lihat http://www.divinewrite.com/docoprocess2.htm)

– Nyatakan tujuan Anda
– Tuliskan spesifikasi konsep Anda
– Rancang beberapa kemungkinan penerapan
– Lakukan pengujian kegunaan pada prototipe Anda
– Tulis spesifikasi kebutuhan Anda
– Perkirakan durasi & sumber daya proyek
– Lakukan pengujian kegunaan pada contoh tulisan Anda
– Tulis spesifikasi pekerjaan & desain pekerjaan Anda

Pasal 3 – Tulis (lihat http://www.divinewrite.com/docoprocess3.htm)

– Tuliskan doco
– Kelola produksi

Jadi begini …

Pahami Proyek Anda

Identifikasi Ruang Lingkup Anda

Langkah pertama dalam proyek apa pun adalah mengidentifikasi apa yang sebenarnya Anda harapkan. Umumnya ini akan terjadi sebelum Anda mengambil pekerjaan, tetapi itu harus tetap menjadi hal pertama yang Anda dokumentasikan.

Mengidentifikasi ruang lingkup Anda melibatkan mencari tahu di mana Anda cocok dalam proses pengembangan secara keseluruhan dan di mana Anda cocok dalam perusahaan. Tidak ada dokumentasi proyek yang hanya merupakan dokumentasi, jadi penting untuk mengetahui dengan tepat apa lagi yang terlibat. Beberapa area lain yang mendokumentasikan orang-orang / harus secara umum dilibatkan dalam meliputi:

– Tinjauan spesifikasi
– Ulasan GUI
– Penelitian persyaratan pengguna produk
– Dokumentasi penelitian kebutuhan audiens
– Pengujian Usability

Semua hal ini merupakan bagian integral dari proses pengembangan, dan harus dijadwalkan dengan benar.

Biasakan Diri Anda dengan Lingkungan Kerja

Kenali semua orang yang terlibat dalam produk. Untuk proyek perangkat lunak, ini berarti manajer proyek, perancang, dan orang-orang yang akan melakukan pengkodean tingkat rendah. Cobalah untuk memiliki hubungan yang baik dengan mereka. Mereka harus menghormati Anda, jika tidak, mereka tidak akan mendengarkan banyak dari apa yang Anda katakan.

Biasakan Diri Anda dengan Produk

Cari tahu apa yang akan terlibat dalam produk. Kamu harus tahu:

– apa tujuan pengembangannya
– persyaratan pengguna apa yang ingin mereka temui
– bagaimana produk akan digunakan
– siapa yang akan menggunakannya
– apa fitur dari produk tersebut
– bagaimana produk akan terlihat dan terasa
– Akankah ini membutuhkan desain doco tertentu? Misalnya, ia hanya dapat berjalan di versi terbaru Windows, ia mungkin memiliki tampilan dan nuansa tertentu, lingkungan tertentu (bahwa bantuan itu mungkin harus diintegrasikan ke dalam), dll.

Ini adalah semua hal yang dapat Anda masukkan, baik melalui kritik sederhana, atau melalui masukan ke dalam persyaratan riset pengguna. Cobalah untuk membaca sebanyak mungkin dokumentasi yang Anda temukan, dan wawancarai sebanyak mungkin orang yang berkepentingan. Saat Anda pergi, catat masalah apa pun yang Anda identifikasi, pertanyaan apa pun yang Anda miliki, atau apa pun yang menurut Anda perlu berbeda.

Beberapa sumber (non-manusia) yang dapat Anda gunakan untuk mencapainya meliputi:

– Fitur dan spesifikasi produk
– Rencana proyek
– Dokumentasi aplikasi pendanaan jika berlaku

Identifikasi Pemirsa untuk Dokumentasi

Diskusikan dengan manajer proyek (dan pemangku kepentingan lainnya khususnya pemasaran) yang dirasakan pengguna / audiens.

Tentukan Persyaratan Pemirsa yang Dirasakan

Buat beberapa tebakan tentang persyaratan pemirsa sehingga Anda dapat memberikan perkiraan kasar durasi produk dan persyaratan sumber daya.

Diskusikan dengan manajer proyek (dan pemangku kepentingan lainnya khususnya pemasaran) kebutuhan pengguna yang dirasakan yang harus dipenuhi oleh bantuan. Lihat apakah seseorang telah meneliti tujuan pengguna, tugas, dan model mental yang digunakan pengguna saat menggunakan produk (atau produk serupa). Jika mereka belum, wawancarai para ahli internal untuk mengidentifikasi sasaran, tugas, model mental yang dirasakan, dll.

Kedua, Anda harus mengidentifikasi apa yang dikatakan teori tentang dokumentasi pengguna (yaitu pendekatan dokumentasi, pertimbangan visual, pertimbangan pengindeksan, dll.). Saya merekomendasikan Minimalism Beyond the Nurnberg Funnel, (1998) disunting oleh John M. Carroll.

Kira-kira memperkirakan durasi dan sumber daya proyek doco

Meskipun, pada tahap ini, Anda tidak benar-benar tahu cukup tentang produk atau persyaratan audiens Anda untuk mengetahui berapa lama dokumentasi akan selesai, manajemen akan tetap seperti perkiraan kasar. Ini baik-baik saja, selama semua orang sadar bahwa ini adalah perkiraan kasar, dan dapat berubah tergantung pada pengetahuan dan penelitian selanjutnya.

Estimasi awal ini harus menyertakan semua waktu yang akan Anda habiskan untuk tahapan yang terjadi sebelum dan sesudah tahap penulisan. Ingat, tahapan ini penting, dan tidak boleh diubah-ubah. (TIP: Dalam proyek yang dikelola dengan baik, perencanaan harus mengambil kira-kira 30% dari waktu Anda, menulis 50%, produksi 19%, dan evaluasi 1%.)

Memperkirakan tahapan pra-menulis

Membiarkan untuk tahap pra-menulis lebih sulit daripada memungkinkan untuk menulis. Jika Anda mengalami masalah, perkirakan tahap penulisan, lalu basiskan semua perkiraan lainnya, gunakan angka di atas sebagai panduan.

Memperkirakan tahap menulis dan pasca-menulis

Karena Anda mungkin masih belum tahu banyak tentang produk atau pengguna, perkiraan Anda di sini akan didasarkan terutama pada kombinasi catatan masa lalu, pengalaman, intuisi (firasat), dan standar industri yang dikombinasikan dengan tujuan dan tugas Anda sudah ditentukan.

Mulailah dengan langkah-langkah berikut.

1. Perkirakan jumlah pekerjaan yang diperlukan untuk mendokumentasikan tugas-tugas yang perlu dilakukan pengguna untuk mencapai tujuan mereka.

2. Lacak setiap dokumentasi dokumen sebelumnya. Lihat apakah Anda bisa referensi silang waktu yang dibutuhkan untuk menghasilkan dokumenter serupa di masa lalu dengan perkiraan kuantitas saat ini. Turunkan angka berdasarkan metode ini.

3. Lihat bagaimana perbandingan ini dengan estimasi yang berasal dari angka standar industri (misalnya, saya pikir standar industri saat ini adalah untuk memungkinkan 1 hari per halaman dokumentasi – ini mencakup semua draf dan ulasan).

4. Bandingkan dua angka dan tentukan kompromi yang baik berdasarkan pengalaman dan intuisi Anda.

5. Cari tahu berapa lama Anda benar-benar harus melakukannya, lalu berapa banyak penulis yang Anda perlukan untuk menyelesaikannya selama waktu ini.

6. Buat jadwal proyek menggunakan sesuatu seperti Microsoft Project. Jangan lupa untuk memberi waktu untuk merekrut, melatih, dan menulis praktik kerja.

TIP: Pada tahap ini, Anda harus menulis draf pertama dari Rencana Proyek Dokumentasi. Ini harus mencakup atau merujuk ke semua langkah yang diuraikan dalam dokumen ini. Pada dasarnya, ini harus mencerminkan proses yang dianjurkan di sini, tetapi spesifik untuk proyek yang Anda kerjakan. Ini juga harus mencakup garis waktu.

Persyaratan Pemirsa Penelitian

Penelitian tentang pengguna produk dan audiens dokumentasi adalah salah satu bagian terpenting dari setiap produk yang sukses. Sayangnya, ini juga salah satu aspek yang paling sering diabaikan dari proyek apa pun. Ini umumnya terjadi karena pembuat keputusan merasa mereka sudah tahu cukup banyak segala sesuatu yang perlu diketahui tentang pengguna dan audiens.

Ketika mengelola proyek dokumentasi, Anda harus menyelidiki kemungkinan melakukan penelitian. Jika Anda bekerja di akhir siklus hidup produk, Anda harus menanyakan apakah riset pengguna telah dilakukan untuk produk itu sendiri. Jika tidak, ada kemungkinan Anda tidak akan mendapat dukungan untuk penelitian audiens.

Penelitian khalayak harus berusaha mengidentifikasi:

– tujuan pengguna (apa yang diharapkan pengguna untuk dicapai dengan produk)
– harapan pengguna dari doco (Panduan? Bantuan online? Tutorial?, Persyaratan kegunaan, persyaratan lokalisasi, dll.)
– model mental pengguna (bagaimana mereka sudah melihat bantuan online, apa kesan mereka tentang itu, dll.)
– tugas pengguna (bagaimana pengguna menggunakan produk untuk mencapai tujuan mereka)
– pengguna mana yang melakukan tugas apa (matriks pengguna / tugas)
– Berapa lama pengguna telah melakukan tugas-tugas ini?
– tugas-tugas mana yang tidak aktif dan mana yang diulang?
– apakah mereka pernah melakukannya secara berbeda?
– apakah mereka melakukan berbagai tugas, atau hanya beberapa?
– apakah mereka tidak suka melakukannya? (Apakah itu membosankan, berulang?)
– apakah mereka merasa sulit?
– tugas mana yang dianggap penting?
– apakah mereka biasanya di bawah tekanan ketika mereka melakukan tugas itu?
– Adakah gangguan lain (lingkungan, sosial, dll.)?

Beberapa metode penelitian untuk dipertimbangkan adalah:

– Pengamatan pengguna yang melakukan pekerjaan mereka di lingkungan kerja mereka
– Kelompok fokus dan wawancara dengan pengguna- Kuesioner

TIP: Untuk detail lebih lanjut tentang metode ini, lihatlah Mengelola Proyek Dokumentasi Anda oleh Hackos (1994), Analisis Pengguna dan Tugas untuk Desain Antar Muka oleh Hackos & Redish (1998), Pemasaran Sosial: Imperatif Baru untuk Kesehatan Masyarakat oleh Manoff (1985) ), Merancang Penelitian Kualitatif Edisi ke-2 oleh Marshall & Rossman (1995), dan “Melakukan Focus Group – Panduan untuk Pengguna First-Time”, dalam Intelijen dan Perencanaan Pemasaran oleh Tynan & Drayton (1988).

Untuk dilanjutkan … Lihat bagian 2 artikel ini (http://www.divinewrite.com/docoprocess2.htm) untuk informasi tentang menyiapkan spesifikasi Anda.

Leave a Reply

Your email address will not be published. Required fields are marked *