Jika Anda telah dituduh menulis dokumen yang seharusnya mengajar orang lain bagaimana melakukan sesuatu, cara hari ini untuk melakukannya sedikit banyak membuang metode lama ke luar jendela.
1. Header Bom Besar
Anda akan melihat tajuk di PCMech, seperti yang tepat di atas kalimat ini, sangat besar. Ini karena mereka lebih mudah dilihat, dibaca, dan diketahui di mana Anda berada dalam dokumen.
2. Lebih Sedikit Kata
Cara yang salah:
Dokumentasi berikut menjelaskan cara menggunakan dan mengoperasikan Fanny Whacker 2000.
Cara yang benar:
Petunjuk tentang cara menggunakan Fanny Whacker 2000
Selalu ingat frasa ini ketika menulis dokumentasi: DAPATKAN KE TITIK SEBAGAI CEPAT
3. Lewati referensi yang tidak berguna
Jika referensi tidak ada hubungannya dengan instruksi inti dari apa yang Anda coba jelaskan, seperti:
Untuk informasi lebih lanjut tentang Turnip Twaddler milik Fanny Whacker 2000, silakan lihat dokumen FU, ayat ID10T.
… jangan lakukan itu.
4. Kencangkan. Selalu.
Tanggal ketika dokumentasi ditulis harus di area footer dari setiap halaman. Jika ini dokumen elektronik, tanggal ditampilkan dua kali. Sekali di awal, sekali di akhir.
Anda dapat menulis ini sebagai "Revisi Terakhir (masukkan tanggal di sini)".
5. Peringatan harus selalu diposting sebelum point of no return
Jika ada sesuatu dalam dokumentasi Anda yang berpotensi merusak / menghancurkan / melenyapkan sesuatu jika dilakukan secara tidak benar, informasi ini harus ditempatkan langsung setelah instruksi tersebut, berada di depan mata (artinya di halaman yang sama) dan beraksen.
Contoh:
Langkah 5. Membersihkan Fanny Whacker 2000
Dayung FW2000 harus dibersihkan dengan lembut menggunakan kain lembut non-abrasif.
PERINGATAN: Hanya gunakan pelarut bebas amonia untuk mencegah FW2000 meledak dan mengakibatkan kematian sebelum waktunya.
Pada catatan akhir, dokumentasi yang baik bukan dari menjadi super-deskriptif tentang setiap hal yang mungkin dibayangkan. Baca dokumentasi Anda dan tanyakan pada diri Anda sendiri, apakah itu memberikan instruksi yang benar? Jika jawabannya adalah ya, pertanyaan selanjutnya adalah, apakah itu diperintahkan dengan cepat ? Jika ya, dokumentasinya bagus.
