Dokumentasi produk
Bantu pengguna menyelesaikan tugas yang didukung oleh aplikasi Anda.
Berikan panduan praktis kepada pengguna yang menjelaskan alur aplikasi dan membantu mereka menyelesaikan tugas mereka.
Ubah fungsi produk menjadi instruksi praktis.
- Siapkan cakupan panduan
Tinjau bagian dokumentasi dan target audiensnya.
- Jawab pertanyaan konten
Jelaskan alur kerja dan informasi yang harus dijelaskan oleh panduan.
- Ikuti pengumuman layanan publik
Periksa perkembangan pembuatan dan alamat situs dokumentasi.
Jelaskan cara menggunakan aplikasi.
Dokumentasi melengkapi presentasi produk dengan instruksi praktis. Mulai dengan panduan memulai, lalu arahkan pengguna melalui alur kerja yang sebenarnya didukung oleh aplikasi.
Konfigurasi dokumentasi menampilkan definisi bagian dan pertanyaan. Berikan konteks yang membantu menjelaskan tugas dalam bahasa pengguna.
Pastikan panduan tetap terhubung ke aplikasi yang sedang digunakan
Lakukan tindakan bermanfaat pertama.. Panduan memulai memberikan jalur singkat bagi pengguna baru untuk menggunakan produk. Panduan tersebut harus menjelaskan di mana harus memulai, informasi apa yang diperlukan, dan hasil apa yang mengonfirmasi bahwa tugas telah selesai.
Jelaskan alur kerja yang berulang. Panduan terperinci mengikuti label dan tindakan aplikasi sebenarnya. Prasyarat, langkah-langkah bernomor, dan hasil yang diharapkan membantu seseorang mengulangi tugas bisnis tanpa menafsirkan deskripsi umum layar.
Jawab pertanyaan lintas topik. Beberapa pertanyaan berkaitan dengan akun, biaya, atau publikasi, bukan hanya satu layar. FAQ memberikan jawaban ringkas dan tautan ke panduan yang relevan, sehingga prosedur tetap berada di satu tempat daripada diduplikasi di seluruh situs.
Pastikan panduan tetap terhubung ke produk
Tinjau dokumentasi setelah ada perubahan aplikasi yang signifikan. Panduan harus menggunakan label dan perilaku yang dapat dilihat pengguna. Translate the text into the requested language, paying attention to the context if present.
Dokumentasi berjalan di layanan publiknya sendiri. Tautkan dari situs web dan periksa panduan dalam bahasa yang diterbitkan oleh proyek Anda.
Bantu pengguna menyelesaikan tugas berikutnya
Panduan praktis menjelaskan dari mana harus memulai, informasi apa yang dibutuhkan, dan cara memeriksa hasilnya. Nilainya terletak pada kemampuannya membantu pembaca bertindak di dalam aplikasi.
Gunakan panduan terkait untuk melanjutkan alur ketika tugas mencakup beberapa area. Tinjau dokumentasi ketika sebuah layar berubah agar petunjuknya tetap berguna setelah ada perubahan.
Dari fungsionalitas yang disepakati menjadi bantuan yang bermanfaat
Siapkan panduan lingkup.. Tinjau bagian dokumentasi dan tugas yang seharusnya dijelaskan. Pastikan pengguna yang dituju dan perilaku aplikasi tetap jelas.
Lengkapi konteks yang hilang. Jawab pertanyaan tentang prasyarat, aturan, dan hasil. Tulisannya harus menggunakan antarmuka yang sebenarnya, bukan kontrol yang dibuat-buat.
Tinjau setelah dipublikasikan dan ubah. Ikuti panduan di aplikasi, periksa bahasa dan tautan terkaitnya, lalu kunjungi kembali saat tugas yang mendasarinya berubah.
Buat produk ini lebih mudah digunakan setelah kunjungan pertama
Berikan instruksi yang mengarah pada hasil, beserta presentasi publik tentang apa yang dilakukan aplikasi.
Pertanyaan tentang Dokumentasi Produk
Halaman fitur membantu calon pengguna memahami kemampuan dan nilainya. Panduan membantu pengguna melakukan tugas, dengan kontrol, prasyarat, dan hasil yang sebenarnya. Keduanya saling melengkapi.
Dokumentasi menyediakan definisi bagian dan pertanyaan. Tinjau tugas-tugas yang didukung aplikasi, berikan konteks yang diperlukan, dan ikuti progres penulisan.
Proyek ini menerbitkan panduan terlokalisasi yang tersedia untuk cakupannya. Tinjau setiap bahasa yang diterbitkan sehingga tetap mempertahankan prosedur lengkap dan label antarmuka yang benar.
Setelah ada perubahan yang memengaruhi tugas, kontrolnya, atau hasil yang diharapkan, periksa teks dengan aplikasi yang sedang berjalan alih-alih berasumsi bahwa instruksi asli masih berlaku.
Referensi endpoint harus termasuk dalam proyek dengan API yang aktif dan berfungsi. Gunakan operasi langsung dan referensi yang sebenarnya; rute yang direncanakan saja tidak cukup untuk mendokumentasikan integrasi yang dapat digunakan.