Dokumentasi produk
Bantu pengguna menyiapkan tugas yang disokong oleh aplikasi anda.
Berikan panduan praktikal kepada pengguna yang menerangkan alur aplikasi dan membantu mereka menyelesaikan tugasan mereka.
Ubah fungsi produk menjadi arahan praktikal
- Sediakan skop panduan
Tinjau bahagian dokumentasi dan audiens yang dituju.
- Jawab soalan kandungan
Jelaskan alur kerja dan maklumat yang perlu dijelaskan oleh panduan.
- Ikuti pengumuman perkhidmatan awam
Periksa kemajuan pembinaan dan alamat tapak dokumentasi.
Terangkan cara menggunakan aplikasi ini.
Dokumentasi melengkapi pembentangan produk dengan arahan praktikal. Mulakan dengan panduan permulaan, kemudian bimbing pengguna melalui alur kerja yang disokong oleh aplikasi itu.
Konfigurasi dokumentasi mendedahkan definisi bahagian dan soalan. Berikan konteks yang membantu menjelaskan tugas dalam bahasa pengguna.
Pastikan panduan tersebut kekal bersambung dengan aplikasi yang sedang digunakan
Sokong tindakan berguna pertama.. Panduan permulaan memberi pengguna baharu laluan ringkas ke dalam produk. Ia harus menerangkan tempat untuk memulakan, maklumat yang diperlukan dan hasil yang mengesahkan bahawa tugas telah selesai.
Jelaskan alur kerja berulang. Panduan terperinci diikuti dengan label dan tindakan aplikasi sebenar. Pra-syarat, langkah-langkah bernombor dan hasil yang dijangkakan membantu seseorang mengulangi tugas perniagaan tanpa menafsirkan penerangan umum tentang skrin.
Jawab soalan merentas bidang.. Beberapa soalan berkaitan dengan akaun, kos atau penerbitan dan bukannya hanya satu skrin. Soalan Lazim (FAQ) menyediakan jawapan ringkas dan pautan ke panduan yang berkaitan, memastikan prosedur berada di satu tempat dan bukannya diduplikasi di seluruh tapak.
Pastikan panduan kekal bersambung dengan produk
Tinjau dokumentasi selepas perubahan aplikasi yang penting. Panduan harus menggunakan label dan tingkah laku yang boleh dilihat oleh pengguna.
Dokumentasi berjalan pada perkhidmatan awamnya sendiri. Pautkannya dari laman web dan semak panduan dalam bahasa yang diterbitkan oleh projek anda.
Bantu pengguna menyelesaikan tugasan seterusnya
Panduan praktikal menerangkan tempat untuk bermula, maklumat yang diperlukan dan cara menyemak hasilnya. Nilainya datang daripada membantu pembaca bertindak dalam aplikasi.
Gunakan panduan berkaitan untuk meneruskan perjalanan apabila tugasan merentas beberapa bidang. Semak dokumentasi apabila skrin berubah supaya arahan kekal berguna selepas sesuatu perubahan.
Dari fungsi yang dipersetujui kepada bantuan yang berguna
Sediakan skop panduan. Tinjau bahagian dokumentasi dan tugasan yang sepatutnya diterangkannya. Pastikan pengguna yang dimaksudkan dan tingkah laku aplikasi jelas.
Sila berikan konteks yang diperlukan. Jawab soalan tentang pra-syarat, peraturan dan hasil. Penulisan harus menggunakan antara muka sebenar dan bukannya kawalan rekaan.
Semak selepas diterbitkan dan ubah. Ikuti panduan dalam aplikasi, semak bahasa dan pautan berkaitan, kemudian lawati semula apabila tugas asas berubah.
Jadikan produk lebih mudah digunakan selepas lawatan pertama.
Berikan arahan yang membawa kepada hasil, bersama dengan paparan awam tentang apa yang aplikasi itu lakukan.
Soalan tentang dokumentasi Produk
Halaman ciri membantu bakal pelanggan memahami keupayaan dan nilainya. Panduan membantu pengguna melaksanakan tugas, dengan kawalan sebenar, keperluan dan hasil. Kedua-duanya saling melengkapi.
Alat dokumentasi menunjukkan definisi bahagian dan soalan. Tinjau tugas yang disokong oleh aplikasi, berikan konteks yang diperlukan, dan ikuti kemajuan penulisan.
Projek ini menerbitkan panduan terlokalisasi yang tersedia untuk skopnya. Tinjau setiap bahasa yang diterbitkan supaya ia mengekalkan prosedur lengkap dan label antarmuka yang betul.
Selepas perubahan yang memberi kesan kepada tugas, kawalannya atau hasil yang dijangkakan. Semak teks terhadap aplikasi yang berfungsi dan bukan berasaskan andaian bahawa arahan asal masih sah.
Rujukan titik akhir adalah milik projek dengan API yang aktif dan berfungsi. Gunakan operasi dan rujukan yang aktif; laluan yang dirancang sahaja tidak mencukupi untuk mendokumentasikan integrasi yang boleh digunakan.