Home » Uncategorized » Proyek Dokumentasi yang Sukses

Proyek Dokumentasi yang Sukses – Bagian 2 dari 3 – ‘Menentukan’ . 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.

Jadi Anda bertanggung jawab untuk mengelola proyek dokumentasi. Anda tahu siapa audiens Anda, apa yang mereka coba capai, bagaimana produk memungkinkan mereka mencapainya, dan apa yang dituntut oleh para penonton dari bantuan tersebut. Sekarang saatnya untuk menentukan niat Anda.

CATATAN: Ini adalah yang kedua dalam serangkaian tiga artikel yang menguraikan elemen-elemen kunci dari proses dokumentasi pengguna yang baik. (Untuk membaca artikel pertama dan ketiga dalam seri ini, buka http://www.divinewrite.com/docoprocess1.htm dan http://www.divinewrite.com/docoprocess3.htm.)

Nyatakan tujuan Anda

Secara umum, pernyataan tujuan Anda harus menunjukkan bahwa Anda berharap untuk membuat rangkaian produk dokumentasi yang akan memenuhi persyaratan audiens. Khususnya, Anda akan memiliki sejumlah sub-tujuan.

(TIP: Mungkin perlu diingat bahwa sasaran yang Anda tetapkan di sini perlu digunakan untuk mengukur keberhasilan produk Anda melalui pengujian internal sendiri serta melalui penelitian pengguna yang evaluatif.) Sub-tujuan semacam itu dapat meliputi:

– Kemudahan penggunaan
– Aksesibilitas
– Bermanfaat
– Akurasi
– Relevansi
– Comprehensiveness
– Ketaatan pada pedoman gaya
– Ejaan dan tanda baca yang benar

Tulis Spesifikasi Konsep Anda – Proyek Dokumentasi yang Sukses

Sasaran Anda ditetapkan, Anda dapat mulai merenungkan apa yang akan Anda hasilkan. Langkah pertama adalah membuat beberapa spesifikasi konsep. Secara sederhana, spesifikasi konsep adalah ikhtisar tingkat yang sangat tinggi dari apa yang Anda usulkan untuk diproduksi.

Misalnya, spesifikasi konsep Anda untuk bantuan online mungkin menyatakan bahwa Anda akan menghasilkan produk yang memungkinkan pengguna untuk mengakses informasi menggunakan TOC, Indeks, dan Temuan.

Mungkin menyarankan beberapa fitur GUI yang mungkin dari elemen-elemen ini, tetapi itu tidak akan menetapkan persyaratan; hanya kemungkinan. Spesifikasi konsep untuk panduan Anda mungkin menyatakan bahwa mereka akan terlihat profesional, akan berisi banyak gambar yang digambar secara profesional, akan memiliki ruang putih yang memadai, akan bergaya, akan dibagi menjadi beberapa bab untuk menyesuaikan sifat berorientasi tugas dari bantuan online, dll.

Umumnya, produk yang Anda usulkan dapat diterapkan dengan berbagai cara. Anda harus menulis satu atau lebih spesifikasi konsep untuk:

– komponen apa yang akan terdiri dari suite dokumentasi (bantuan online, manual cetak, tutorial, ikhtisar, dll.) – “Spesifikasi Spesifikasi Produk Dokumentasi”

– jenis informasi yang akan ada dalam dokumentasi Anda (misalnya, struktur TOC, apakah Anda akan mengikuti praktik minimalis?) – “Spesifikasi Konsep Dokumentasi Konten”

– fungsionalitas dan antarmuka pengguna dari suite dokumentasi Anda (misalnya, bagaimana itu akan bekerja dan bagaimana audiens akan berinteraksi dengannya) – “Online Help Spesifikasi Konsep Antarmuka Pengguna”, “Dicetak Spesifikasi Konsep Antarmuka Pengguna Dokumentasi”, dll.

– metode pengiriman (bagaimana Anda akan mengirimkan bantuan kepada pengguna dan bagaimana Anda memperbaruinya)

– bahasa apa yang akan dibuat dokumentasi

Rancang beberapa kemungkinan penerapan

Kini setelah Anda memutuskan secara kasar apa yang ingin Anda hasilkan, Anda dapat mendesain beberapa kemungkinan penerapannya. Desain Anda akan sangat tinggi tingkat dan mereka mungkin tidak benar-benar berfungsi (mereka sebenarnya hanya prototipe kertas).

Dengan sebagian besar pertimbangan lain yang sudah diselesaikan melalui riset kebutuhan pengguna Anda, penerapan ini hanya berbeda karena:

– teknologi di belakang mereka
– alat yang digunakan untuk membuatnya
– tampilan dan nuansa keseluruhan

Anda perlu belajar sebanyak mungkin tentang hal-hal ini, untuk menentukan apa yang sebenarnya mungkin, sukses, efektif, dll. Anda harus menyadari tren saat ini, literatur, kertas putih, dll. Informasi ini dapat diperoleh dari berbagai sumber. Beberapa tempat bagus untuk memulai meliputi:

– Daftar server
– Konferensi
– Buku
– Publikasi lainnya
– Penulis lain
– Produk-produk lain

Lakukan pengujian kegunaan pada prototipe Anda

Model (prototipe) desain Anda untuk pengambil keputusan dan sampel penonton. Ini memungkinkan Anda untuk memilih fitur terbaik dari masing-masing desain (dan menentukan prioritas untuknya). Pilih desain (atau gabungkan beberapa desain) yang Anda yakini memenuhi persyaratan pengguna terbaik.

Proses ini mungkin berulang. Pada akhir tahap ini, Anda harus cukup tahu untuk detail apa yang akan Anda hasilkan (termasuk platform dan alat bantu apa yang akan Anda gunakan).

TIP: Untuk rincian tentang metode penelitian yang mungkin, lihatlah Mengelola Proyek Dokumentasi Anda oleh Hackos (1994) khususnya. pp.446-447, Analisis Pengguna dan Tugas untuk Perancangan 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 Marketing Intelligence and Planning oleh Tynan & Drayton (1988).

Tulis Spesifikasi Kebutuhan Anda

Spesifikasi persyaratan detail persis apa yang Anda harus berakhir dengan. Spesifikasi ini harus berisi sedetail mungkin tentang fitur dan fungsionalitas produk dokumentasi (bukan bagaimana Anda akan membangunnya).

Pada dasarnya merupakan evolusi dari spesifikasi konsep Anda. Setelah Anda mulai bekerja pada spesifikasi kebutuhan Anda, spesifikasi konsep secara efektif dibekukan. Anda harus menulis satu atau lebih spesifikasi konsep untuk:

– komponen-komponen apa yang akan terdiri dari rangkaian dokumen (bantuan online, manual cetak, tutorial, ikhtisar, dll.) – “Spesifikasi Spesifikasi Produk Dokumentasi”

– jenis informasi yang akan ada dalam dokumentasi Anda (misalnya, struktur TOC, apakah Anda akan mengikuti praktik-praktik minimalis?) – “Spesifikasi Persyaratan Isi Dokumentasi”

– fungsionalitas dan antarmuka pengguna dari kumpulan dokumen Anda (misalnya, bagaimana itu akan bekerja dan bagaimana audiens akan berinteraksi dengannya) – “Kebutuhan Spesifikasi Antarmuka Pengguna Bantuan Online”, “Spesifikasi Spesifikasi Antarmuka Pengguna Dokumentasi Cetak”, dll.

– metode pengiriman (bagaimana Anda akan mengirimkan bantuan kepada pengguna dan bagaimana Anda memperbaruinya)

– bahasa apa yang akan dibuat dokumentasi

Perkirakan Durasi & Sumber Daya Proyek

Setelah Anda menyelesaikan tahap spesifikasi persyaratan, Anda harus cukup tahu untuk secara akurat memperkirakan durasi dan persyaratan sumber daya untuk sisa proyek. Anda juga harus memperbarui dokumen “Rencana Rencana Dokumentasi” dengan informasi ini.

Memperkirakan selalu merupakan proses yang sulit, dan tidak ada cara pasti untuk membuatnya benar. Sebagian besar tergantung pada pekerjaan dan pengalaman Anda. Namun, berikut beberapa panduan yang mungkin bisa membantu Anda.

Jika Anda memiliki catatan dari proyek sebelumnya, Anda mungkin dapat memperkirakan durasi proyek berdasarkan ini. Anda harus mencoba membandingkan materi dan topik lama dengan yang baru untuk memastikan bahwa waktu yang lama akan berlaku untuk proyek baru.

Pada p.174 Mengelola Proyek Dokumentasi Anda (1994), Hackos menyediakan beberapa panduan yang berpotensi bermanfaat untuk membandingkan kompleksitas berbagai proyek dokumentasi.

Jika, di sisi lain, proyek ini sepenuhnya baru, Anda tidak akan memiliki catatan untuk digunakan sebagai panduan (kecuali Anda pernah mengelola proyek serupa di masa lalu). Dalam situasi ini, perkiraan proyek akan sangat sulit dilakukan.

Salah satu metode yang mungkin untuk memperkirakan adalah:

1. Susun daftar tugas, dan catat berapa banyak yang ada di daftar Anda.

2. Susun daftar konsep yang harus didokumentasikan, dan catat berapa banyak yang ada di daftar Anda.

3. Dari daftar tugas Anda, pilih 10 yang mewakili sisanya (dalam hal kompleksitas, panjang yang diharapkan, status pengembangan yang relevan, dll.), Dan perincian yang sama (misalnya, Anda dapat menulis satu topik untuk setiap).

4. Dari daftar konsep Anda, pilih 3 yang mewakili sisanya, dan perincian yang sama (misalnya, Anda dapat menulis satu topik untuk masing-masing).

5. Perkirakan jumlah halaman per topik.

6. Dokumentasikan tugas dan konsep ini sebagai percobaan, memastikan bahwa Anda melacak:

-total waktu yang dibutuhkan untuk menyelesaikan setiap topik.
– porsi waktu ini yang disebabkan oleh perubahan atau ketidakpastian produk.
– jumlah halaman per topik.
– jumlah tambahan, tak terduga, tetapi perlu, topik yang Anda sadari sebagai hasil dari dokumentasi. Simpan catatan terpisah dari nomor untuk kedua tugas dan topik konseptual.

KIAT: Manfaatkan sepenuhnya dokumen uji coba Anda. Meskipun Anda telah memilih desain melalui desain prototipe, Anda dapat menggunakan contoh dokumentasi Anda untuk menguji kegunaan pendekatan dokumentasi Anda.

Proyek Dokumentasi yang Sukses

Dengan menyajikan sampel ke sampel audiens, Anda dapat menentukan apakah Anda menuju arah yang benar dengan dokumen Anda (yaitu apakah Anda telah menafsirkan dan menerapkan hasil penelitian pengguna Anda dengan benar).

7. Tentukan waktu rata-rata yang diambil per halaman untuk tugas dan untuk topik-topik konseptual.

8. Terapkan rata-rata ini ke seluruh topik dalam proyek. (Topik yang ditulis di awal proyek biasanya memakan waktu lebih lama karena kurangnya informasi dan jumlah masalah teknis yang lebih tinggi. Ini berarti topik yang ditulis kemudian dalam proses mungkin akan memakan waktu kurang dari rata-rata yang dihitung di sini. Namun, ini biasanya akan diimbangi oleh perubahan produk waktu ekstra akan dikenakan selama siklus hidup proyek.)

9. Perkirakan waktu per bidang subjek berdasarkan waktu rata-rata per topik.

10. Perkirakan jumlah ekstra, tak terduga, topik yang mungkin akan diperlukan selama sisa proyek.

11. Izinkan pelatihan, perawatan prac pekerjaan, hari libur, hari sakit, pertemuan, pengujian kegunaan, produksi (sekitar 6 minggu waktu penyelesaian untuk mencetak 1000 halaman manual, termasuk pemeriksaan), evaluasi, dan pengujian evaluatif.

Masing-masing elemen ini akan bervariasi sesuai dengan sifat proyek, dan mereka akan cenderung mengambil lebih sedikit waktu daripada penulisan yang sebenarnya. Itulah mengapa tidak ada pedoman khusus yang diberikan untuk menulis.

Cari tahu berapa lama Anda benar-benar harus melakukannya, lalu berapa banyak penulis yang Anda perlukan untuk menyelesaikannya selama waktu ini. Buat jadwal proyek menggunakan sesuatu seperti Microsoft Project, mengidentifikasi tonggak yang berguna dan tenggat waktu proyek. Beberapa pencapaian Anda mungkin termasuk:

– Pengujian Prototipe Lengkap
– Work Pracs Ditulis
– Spesifikasi Desain Tertulis
– Draf Pertama Lengkap
– Draf Kedua Lengkap
– Lokalisasi Draf Kedua Lengkap
– Draf Akhir Lengkap
– Pelengkapan Lokal Lengkap
– Dokumentasi Siap Dibebaskan
– Produksi Selesai
– Evaluasi Proyek Lengkap
– Pengujian Usability Pasca-rilis Selesai

Penting untuk diperhatikan bahwa Anda akan memiliki pencapaian sebelum titik ini, tetapi karena mereka terjadi sebelum tahap penjadwalan formal, mereka tidak perlu dimasukkan dalam jadwal ini.

Tulis Work Pracs & Spesifikasi Desain

Seiring dengan riset pengguna, spesifikasi pekerjaan dan desain mungkin merupakan elemen proyek yang paling mudah untuk diabaikan, terutama untuk tim kecil. Namun, bahkan dalam tim kecil, akan sangat membantu untuk mempertahankan keduanya.

Work Prac adalah untuk hal-hal yang sedang berlangsung, yang memengaruhi lingkungan kerja sehari-hari tim (misalnya, Cara menggunakan alat dokumentasi Anda, Bagaimana cara melepaskan bantuan Anda, panduan gaya, dll.). Spesifikasi desain adalah untuk mendokumentasikan satu hal seperti bagaimana kita sebenarnya berencana untuk melakukan hal ini.

Ini akan mencakup informasi seperti alat apa yang akan kita gunakan, apa yang masing-masing akan lakukan, dan mekanisme bagaimana semuanya cocok bersama. misalnya, Bagaimana proyek VSS akan berfungsi, bagaimana semuanya harus dikelola, masalah multi-pengguna, bagaimana itu akan dilokalkan, dll.

Untuk dilanjutkan … Lihat bagian 3 artikel ini (http://www.divinewrite.com/docoprocess3.htm) untuk informasi tentang menulis dokumentasi pengguna Anda.

Leave a Reply

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