Utama
Seberapa Miskin Dokumen Pengguna Di Rumah Mengenakan Biaya Anda Dua Kali & Apa yang Harus Dilakukan Tentang Itu

Seberapa Miskin Dokumen Pengguna Di Rumah Mengenakan Biaya Anda Dua Kali & Apa yang Harus Dilakukan Tentang Itu

Banyak organisasi menghasilkan alat internal atau memodifikasi alat yang tersedia secara komersial untuk penggunaannya sendiri. Alat-alat ini harus didokumentasikan sehingga bermanfaat bagi orang lain di organisasi.

Jika dokumentasi ini tidak dibuat atau ditulis dengan buruk, biayanya dua kali:

* Biaya pertama (dikaitkan dengan dokumen pengguna yang buruk) adalah biaya menjawab pertanyaan Pengguna (dukungan teknis).

* Biaya kedua, muncul dari hilangnya waktu karyawan Anda mencoba memahami Dokumen Pengguna yang buruk.

Orang yang tinggal di ruang kecil - Hong Kong: Kota Tersibuk di Dunia | BBC Two

Biaya psikologis juga mempengaruhi Pengguna eksternal dan in-house.

BIAYA PERTAMA: DUKUNGAN TEKNIS

Ini adalah biaya yang Anda keluarkan setiap kali Anda menghasilkan Dokumen Pengguna yang buruk (atau tidak ada). Itu muncul untuk setiap Pengguna ketika dia membutuhkan dukungan teknis. Untuk Pengguna eksternal, biayanya adalah staf dukungan teknis Anda, saluran telepon bebas pulsa, dll.

Untuk Pengguna internal, biaya adalah waktu yang dihabiskan oleh pengembang atau pengubah alat untuk menjawab pertanyaan rekan kerjanya. Ini adalah biaya dukungan teknis yang mahal ... orang-orang ini biasanya dibayar lebih dari staf dukungan teknis Anda. Dengan demikian biaya pertama ini bahkan lebih besar untuk dokumentasi in-house yang buruk daripada untuk dokumentasi jelek yang dirilis ke publik.

BIAYA KEDUA: WAKTU DAN SUMBER DAYA PENGGUNA

Untuk Pengguna di luar perusahaan Anda, biaya kedua ditanggung oleh Pengguna sendiri atau majikan mereka. Pengguna yang bingung ini menghabiskan waktu perusahaan mereka: waktu yang hilang saat mencoba untuk membuat produk berfungsi, dan waktu yang dihabiskan untuk berurusan dengan dukungan teknis Anda.

Untuk Pengguna internal, biaya ini ditanggung oleh perusahaan Anda. Karyawan Anda - pada waktu Anda - yang membuang-buang sumber daya perusahaan Anda mencoba menggunakan produk atau dokumen misterius. Di sinilah kekurangan dokumentasi internal Anda dua kali lipat.

BIAYA PSIKOLOGI MEMPENGARUHI SEMUA PEMBACA

Selain waktu dan biaya moneter ini, ada biaya psikologis yang ditimbulkan oleh Dokumentasi Pengguna yang buruk.

Untuk Pengguna yang frustrasi di luar perusahaan Anda, dokumentasi Anda yang buruk menghasilkan persepsi negatif tentang perusahaan Anda dan produk-produknya. Ini dapat mengakibatkan hilangnya bisnis.

Untuk pengguna di dalam perusahaan Anda, biaya psikologis berkurang semangat kerja karyawan, sebagaimana dibuktikan dari pernyataan yang mungkin:

* Perusahaan kami memproduksi sampah ini?

* Orang-orang ini tidak tajam seperti yang saya kira.

* Jika karyawan lain dapat menghasilkan hal yang membingungkan ini, maka saya dapat bekerja pada level yang sama.

Dengan demikian niat buruk di luar perusahaan Anda dapat membebani Anda dengan penjualan di masa depan; niat buruk di dalam perusahaan Anda dapat menurunkan moral karyawan.

SOLUSI: REVIEW INFORMAL

Begitu seseorang menulis Dokumen Pengguna untuk alat internal, dokumen itu harus ditinjau secara informal.

ULASAN DIRI

Penulis dapat melakukan review pertama sendiri.

Gunakan pemeriksa ejaan pengolah kata Anda untuk memperbaiki kesalahan umum. Anda dapat menggunakan pemeriksa tata bahasa pengolah kata, namun sebagian besar tidak akurat.

Sebelum melakukan tinjauan ini, biarkan dokumen itu duduk selama satu atau dua hari. Ini akan membantu Anda melupakan apa yang Anda maksudkan dalam tulisan Anda yang tidak jelas. Ketika Anda melakukan review dan Anda menemukan diri Anda bertanya :apa maksud saya di sini?: Anda akan menemukan tempat di dokumen yang perlu direvisi.

Saat melakukan tinjauan, bayangkan Anda adalah pengguna alat dan pembaca dokumen. Bayangkan tugas yang ingin dilakukan pengguna alat. Apakah dokumen memungkinkan Pembaca untuk menemukan apa yang dia butuhkan? Apakah tulisannya akurat (menggambarkan alat dengan tepat), jelas, dan lengkap? Buat perubahan yang akan meningkatkan dokumen.

TINJAUAN EKSTERNAL

Kemudian, jika mungkin, gunakan peninjau eksternal (di dalam perusahaan Anda). Untuk melakukan ini, penulis harus:

1. Temukan Pengguna potensial alat ini. Ini haruslah seseorang yang belum terbiasa dengan alat, dan sebagai yang serupa dengan target audiens alat sebagai masuk akal.

2. Mintalah pengulas menggunakan dokumen untuk membimbingnya dalam menggunakan alat ini. Mintalah komentar pada dokumen. Perhatikan perubahan yang disarankan, penambahan, penghapusan, klarifikasi yang diminta oleh reviewer. Beberapa pertanyaan yang mungkin diajukan meliputi:

* Apakah dokumen memberi tahu Anda apa yang perlu Anda ketahui?

* Apakah mudah untuk menemukan apa yang Anda butuhkan dalam dokumen?

* Apakah dokumen menjawab pertanyaan Anda? Jika tidak, pertanyaan apa yang tidak terjawab?

* Apakah dokumen mudah diikuti? Jika tidak, di mana area masalahnya?

3. Penulis harus melakukan perubahan seperlunya.

Jika Anda tidak dapat melakukan tinjauan :semiformal: ini, mintalah orang lain selain Anda untuk hanya membaca dokumen, dan membuat saran untuk perbaikan.

PERINGATAN

Pastikan bahwa proses peninjauan tidak menjadi penghambat bagi mereka yang menulis Dokumentasi Pengguna untuk Pengguna internal. Tekankan mekanisme koperasi - bukan permusuhan - yang hasilnya adalah pekerjaan yang berkualitas. Jangan mencoba membuat Dokumen Pengguna yang sempurna.