Referensi yang baik untuk contoh dokumentasi Pengguna Akhir dan saran [ditutup]

Perangkat lunak in-house kami telah digunakan untuk banyak pengguna dan departemen pelatihan meminta kami tip format dokumentasi pengguna akhir.

Adakah yang tahu di mana saya bisa menemukan contoh yang bagus dari dokumentasi pengguna akhir perangkat lunak yang digunakan departemen pelatihan untuk inspirasi atau situs dengan nasihat yang bagus?

Ini mirip dengan pertanyaan ini namun saya mencari dokumentasi pengguna akhir untuk digunakan oleh pengguna non-teknis.

Anda mungkin ingin memulai dengan mewawancarai pengguna internal Anda tentang perangkat lunak, dan mencari tahu informasi apa yang ingin mereka ketahui.

Sebagian besar dokumentasi yang saya tulis tentang perangkat lunak memiliki satu atau banyak pemirsa dalam pikiran. Departemen pelatihan Anda mungkin akan mendapat manfaat dari kerangka topik (seperti TOC). Jadi Anda bisa mendiskusikan topik apa yang relevan dan apa yang tidak relevan dengan tujuan pelatihan mereka.

Beberapa topik dapat mencakup:

1. Target Pemirsa
2. Persyaratan Teknis
3. Cara Memasang (jika ada)
4. Proses (mis., Fungsi bisnis apa yang dijalankan perangkat lunak?)
5. Featureset (fitur apa yang dimiliki perangkat lunak?)
   • Anda bisa memiliki pendekatan berbasis tugas untuk ini, mis. Tambah Pengguna atau Tambah Dokumen
   • Anda bisa memiliki pendekatan berbasis objek, misalnya Pengguna, Peran
   • Anda dapat memiliki pendekatan berbasis Menu, misalnya menu File, Lihat Menu
6. Terakhir, kemungkinan fitur yang Akan Datang dan bagian FAQ mungkin bertindak sebagai gudang pengetahuan yang berkembang dari produk Anda.

Cobalah untuk mengantisipasi bagaimana pengguna akhir Anda menggunakan perangkat lunak Anda, berdasarkan pada pengetahuan Anda tentang pengembangannya, pengetahuan Anda tentang apa yang dilakukannya dan juga berdasarkan (semoga) wawancara Anda dengan pengguna akhir.

Yang paling penting, cobalah membuat dokumentasi yang ingin Anda baca, gunakan nama contoh yang menyenangkan untuk diperagakan, dan gunakan banyak tangkapan layar beranotasi.

Semoga ini membantu

Saya telah membaca beberapa "Panduan Pengguna Akhir", dan menulis satu, dan saya pikir ada banyak elemen yang meningkatkan efektivitasnya:

• Tunjukkan dengan gambar bagaimana mengeluarkan beberapa perintah, atau membuat beberapa tindakan (misalnya screenshot).
• Fokus pada kebutuhan untuk melakukan sesuatu, dan cara untuk menyelesaikannya. Jauhi deskripsi teknis tentang seberapa optimal tindakan itu dilakukan misalnya.
• Suatu ketika saya meletakkan diagram alir yang menjelaskan modul-modul perangkat lunak itu dibagi, dan saya menerima komentar bahwa itu tidak terlalu berguna.
• Cobalah untuk melihat kemungkinan masalah yang mungkin dialami pengguna, sehingga bagian Pemecahan Masalah Anda menjadi berguna. Anda juga harus menguji program Anda dengan pengguna yang tidak terlibat dalam pengembangannya, bahkan rekan kerja Anda yang terbangun pada proyek lain.
• Hindari deskripsi yang membosankan. Informasi lebih lanjut dapat dimasukkan ke dalam lampiran atau sesuatu seperti itu.

Semoga ini bermanfaat bagi Anda.

Anda menyebutkan bahwa itu akan digunakan untuk pelatihan.

Jika Anda mencari dokumen pelatihan daripada dokumen referensi, situs favorit saya adalah tutorial Joel Spolsky tentang Mercurial di sini .

1. Presentasi sederhana dan bersih. Sangat menyenangkan untuk melihat.
2. Wewenang, tetapi nada pribadi. Rasanya seperti Anda berada di kuliah yang luar biasa.
3. Gambar sederhana, bukan jumlah tangkapan layar aktual yang berlebihan. Baca Bagian Belakang Serbet mengapa ini bekerja.

Jika dokumen pelatihan Anda 1/2 sekeren tutorial Mercurial Joel, saya akan membacanya. Tetapi Anda membutuhkan seseorang dengan a) hasrat untuk menulis dan b) pengetahuan yang luar biasa untuk melakukannya, bahkan jika Anda dapat menyalin 3 poin di atas. Semoga berhasil.

Saya tidak tahu apakah ini mungkin sesuai dengan kebutuhan Anda, tetapi ada sistem di luar sana yang digunakan untuk dokumentasi teknis sphinx yang datang ke pikiran yang memfasilitasi pembuatan dokumentasi online. Bisakah sesuatu seperti ini digunakan untuk apa yang Anda minati?

Saya juga hanya berlari di ReadTheDocs yang melakukan banyak hal yang sama tetapi merupakan solusi yang di-host.

Lihatlah Masyarakat untuk Komunikasi Teknis (STC) . Banyak pemenang penghargaan mereka menulis produksi yang umumnya tersedia. Mereka mungkin juga memiliki sampel yang tersedia. Menjadi anggota juga akan memberikan akses ke kumpulan informasi yang lebih besar.