6 contoh dokumentasi perangkat lunak terbaik dan praktik terbaik

Ingin tahu keberhasilan di balik produk perangkat lunak yang bagus dan berkembang?

Ini dokumentasi mereka.

Perusahaan yang baik berinvestasi banyak ke dalam dokumentasi perangkat lunak mereka. Faktanya, hal pertama yang mereka lakukan adalah membuat dokumentasi yang mencakup tujuan perangkat lunak, ruang lingkup, kerjanya, dan referensi industri.

Hal ini memungkinkan para pemangku kepentingan untuk mengintip biaya pengembangan perangkat lunak, garis waktu, sudut dan strategi pemasaran, kesenjangan fungsionalitas, dan fitur utama yang harus difokuskan.

Tidak hanya membantu dengan pengembangan, dokumentasi perangkat lunak adalah salah satu metode yang paling umum digunakan untuk melatih karyawan baru, mengganti pelanggan baru, dan memberikan dukungan.

Kami juga telah membuat beberapa perangkat lunak dan dokumentasinya, dari sana kami dapat memandu Anda dengan dokumentasi perangkat lunak Anda .

Jadi, mari kita mulai!

Kami dengan ketat menguji dan meneliti setiap produk yang kami rekomendasikan melalui Herothemes. Proses peninjauan kami. Kami juga dapat memperoleh komisi jika Anda melakukan pembelian melalui tautan kami.

Apa itu dokumentasi perangkat lunak?

Dokumentasi perangkat lunak adalah materi tertulis atau video yang membantu dalam pengembangan perangkat lunak, mencatat proses pengembangan dan kemajuan, menjelaskan bagaimana aplikasi perangkat lunak bekerja, memandu pengguna yang menggunakan perangkat lunak secara efektif, dan berfungsi sebagai bahan dukungan pelanggan.

Jenis Dokumentasi Perangkat Lunak

Proyek perangkat lunak dapat memakan waktu beberapa hari hingga beberapa tahun untuk diselesaikan. Jadi sebelum dimulai dengan perangkat lunak bisnis apa pun, penting untuk memahami apa yang Anda selami.

Akibatnya, dokumentasi perangkat lunak mencakup sejumlah besar dokumentasi. Dari tahap perencanaan hingga mematuhi hukum.

Beberapa dokumen yang diproduksi dalam siklus hidup pengembangan perangkat lunak, sumber - cds.cern.ch

Ini akan membantu Anda mendapatkan ide umum tentang cara memulai dokumentasi perangkat lunak Anda dan hal -hal yang harus dibahas di dalamnya.

1. Dokumentasi Proyek

Dokumentasi proyek dibuat selama tahap awal pembuatan perangkat lunak, dan dikelola sepanjang siklus hidupnya.

Karena memberikan pandangan mata burung pada proses pengembangan perangkat lunak, ini sangat membantu dalam pengambilan keputusan.

Ini mencakup penelitian, pengujian, ide, contoh, alokasi sumber daya, rincian pertemuan, kemajuan kerja, tonggak sejarah, dan tujuan masa depan.

2. Dokumentasi Persyaratan dan Desain

Persyaratan dan dokumentasi desain keduanya bekerja dengan tangan. Ini seperti membuat sketsa kasar perangkat lunak Anda sebelum Anda benar -benar mulai mengkodekannya.

Ini termasuk komponen kunci seperti:

• Tinjauan Sistem
• Tujuan dan sasaran tingkat tinggi
• Persyaratan fungsional
• Kriteria penerimaan
• Arsitektur Sistem
• Tumpukan Teknologi

Sementara dokumentasi persyaratan berfokus pada apa yang harus dilakukan sistem, dokumentasi desain berfokus pada bagaimana sistem akan dibangun.

Praktik Terbaik: Yang terbaik adalah mencantumkan semua kebutuhan Anda dari perangkat lunak dan membaginya menjadi beberapa tahap. Ini akan membantu Anda merancang perangkat lunak yang lebih baik sejak awal.

Banyak perangkat lunak didesain ulang (misalnya, ditulis ulang dalam bahasa yang berbeda, atau terstruktur ulang) hanya karena tidak dirancang dengan benar.

3. Dokumentasi Teknis

Dokumentasi teknis mencakup bagaimana sistem perangkat lunak dibangun, dioperasikan, dan dipelihara.

Dalam dokumentasi perangkat lunak Anda harus membuat dokumentasi teknis untuk menjelaskan:

• Bagaimana Kode Bekerja
• API (Antarmuka Pemrograman Aplikasi)
• Skema Database (Tabel, Hubungan, dan Aliran Data)
• Cara meningkatkan dependensi perangkat lunak
• Pemandu Pemecahan Masalah

Kami memiliki panduan lengkap untuk membuat dan menulis dokumentasi teknis, periksa!

4. Dokumentasi Pengguna

Dokumentasi pengguna membantu pengguna akhir (pelanggan) menggunakan perangkat lunak Anda secara efektif.

Itu termasuk:

• Panduan Pengguna : Dibuat untuk pengguna akhir. Misalnya, bagaimana pengguna dapat menggunakan fitur tertentu dari produk Anda.
• Materi Pelatihan: Ini berisi berbagai sumber daya pelatihan untuk pengguna akhir. Misalnya, panduan pengaturan, video, atau kursus.

Dokumentasi pengguna sedikit berbeda dari dokumentasi teknis, kami memiliki beberapa panduan yang akan membantu Anda mempelajari lebih lanjut:

• 5 Contoh Dokumentasi Pengguna Terbaik (Good & Bad + Tips)
• Cara Membuat Panduan Pengguna: Dari Nol ke Pahlawan (Panduan Lengkap)

5. Dokumentasi Pengujian

Dokumentasi atau pedoman pengujian yang dibuat khusus untuk tim QA (jaminan kualitas). Untuk memastikan kualitas perangkat lunak memenuhi standar pasar atau memenuhi permintaan pemangku kepentingan.

Itu termasuk:

• Rencana Uji dan Kasus Uji
• Daftar periksa untuk diikuti saat menguji fitur perangkat lunak
• Pedoman Kualitas Kode
• Tes otomatis

6. Dokumentasi Pemeliharaan / Keamanan

Jenis dokumentasi ini membantu pengembang dan tim untuk memelihara, memperbarui, men -debug, dan memecahkan masalah perangkat lunak.

Itu termasuk:

• Perbarui pedoman, atau daftar periksa
• Panduan untuk memperbarui dependensi perangkat lunak
• Kontrol akses
• Rencana insiden
• Catatan Rilis

7. Dokumentasi Hukum dan Kepatuhan

Dokumentasi hukum dan kepatuhan untuk memastikan perangkat lunak mengikuti standar hukum, peraturan, dan industri.

Dokumen hukum seperti:

• Perjanjian Lisensi Pengguna Akhir (EULA)
• Ketentuan Layanan (TOS)
• Kebijakan Privasi
• Lisensi Perangkat Lunak dan Informasi Penggunaan

Dokumen kepatuhan seperti:

• Perlindungan Data dan Kepatuhan Privasi, yang mencakup peraturan seperti GDPR, CCPA, atau HIPAA.
• Kepatuhan keamanan
• Kepatuhan aksesibilitas
• Peraturan khusus industri

Jelajahi : Apa itu dokumentasi perangkat lunak?

6 contoh dokumentasi perangkat lunak terbaik untuk dipelajari

1. WordPress

Kemungkinan Anda sudah menggunakan WordPress sebelumnya, jadi ini mungkin contoh dokumentasi perangkat lunak terbaik untuk dipelajari.

WordPress digunakan pada 43% dari semua situs web di web. Jadi dokumentasinya harus menjadi salah satu yang terbaik untuk melayani jutaan orang dari seluruh dunia.

Itu termasuk pengembang, desainer, blogger, penulis, atau siapa pun yang ingin membangun situs web.

Dokumentasi utama WordPress dibagi menjadi tiga bagian yang berbeda :

1. Pelajari WordPress: Termasuk panduan dalam bentuk kursus mendalam, video dan tutorial tertulis. Ditargetkan untuk pengguna pemula, menengah dan lanjutan.
2. Dokumentasi Utama: Ditujukan untuk pengguna normal. Untuk memberikan gambaran tentang fitur WordPress, dalam bentuk tutorial tertulis singkat.
3. Sumber daya pengembang: ditujukan untuk pengembang yang membuat tema, plugin, atau ingin memperluas WordPress dengan pengkodean khusus. Ini termasuk pemandu mulai, dokumentasi API, dan contoh pengkodean.

Secara keseluruhan, ini menciptakan pusat sumber daya yang sempurna bagi siapa saja yang ingin membuat situs web atau memulai dengan WordPress. Mudah dinavigasi, mencari ramah, mendalam, penuh dengan contoh, dan sangat berguna.

Hal -hal untuk dipelajari dari dokumentasi perangkat lunak WordPress:

• Mereka tahu audiens mereka , sebagai hasilnya Anda dapat melihat beberapa bagian dokumentasi dan panduan yang dibuat berdasarkan tingkat pengetahuan atau keahlian pengguna .
• Pembaruan berkelanjutan . Dokumentasi perangkat lunak bukanlah hal satu kali, fitur perangkat lunak, UI atau fungsionalitas dapat berubah dari waktu ke waktu. Hal yang sama terjadi dengan WordPress (dari tema klasik untuk memblokir tema dan penambahan Gutenberg) dan mereka memastikan untuk memperbarui dokumentasi mereka dengan setiap pembaruan.
• Forum Dukungan . Selain tutorial dan panduan premade, WordPress juga menyertakan forum dukungan untuk setiap plugin, dan tema. Ini sangat membantu jika pengguna mengalami kesulitan memecahkan masalah sendiri.
• SEO (Friendly Engine Pencari) . Dalam karir 9+ tahun saya sebagai pengguna WordPress , saya jarang mengunjungi atau menelusuri dokumentasi WordPress secara langsung. Yang saya lakukan adalah mencari di Google dan saya menemukan solusi untuk pertanyaan saya. Dokumen WordPress dan halaman dukungan yang dibuat pengguna dengan mudah diindeks di Google (atau mesin pencari lainnya) yang memungkinkan Anda untuk dengan mudah menemukannya.
• FAQ . Sebagian besar FAQ waktu terlewatkan dalam dokumentasi. Tapi WordPress tidak melewatkannya. FAQ memberikan informasi instan atau solusi, dan mudah dipindai.
• Sistem umpan balik . Anda dapat memberikan umpan balik pada setiap panduan, yang merupakan fitur yang bermanfaat untuk menemukan pemandu yang sudah ketinggalan zaman dan tidak membantu.

Apa yang tidak disukai tentang dokumentasi WordPress:

• Tidak ada dokumentasi multibahasa . Meskipun Anda dapat dengan mudah menemukan panduan WordPress pihak ketiga dalam bahasa Anda. Tapi saya berharap WordPress telah membuat beberapa tutorial untuk bahasa populer.

2. Basis Pengetahuan Herothemes

Dokumentasi perangkat lunak kami sendiri.

Ini bukan contoh terbaik di luar sana, tetapi mengingat sebagian besar dari Anda memiliki situasi yang sama dengan kita:

• Tidak tahu harus mulai dari mana
• Anggaran rendah

Ini bisa menjadi contoh yang baik untuk dipelajari.

Herothemes menyediakan plugin dukungan pelanggan, termasuk basis pengetahuan heroik yang memungkinkan pengguna untuk membuat basis pengetahuan atau situs web dokumentasi tanpa pengetahuan pengkodean, untuk penggunaan publik dan internal.

Hal -hal yang harus dipelajari dari contoh dokumentasi Herothemes:

• Membuat hanya dokumentasi yang diperlukan dan memperbaikinya. Herothemes memiliki sangat sedikit panduan, mengingat sebagian besar pelanggan yang ditargetkan adalah tingkat menengah (pengembang, pengguna WordPress) dan perangkat lunaknya sangat mudah dan mudah digunakan.
• Daftar Isi (TOC) . Mengingat beberapa panduan ini berisi walkthrough lengkap, TOC membantu menemukan informasi yang diperlukan.
• Tangkapan layar . Karena sebagian besar dari kita tidak dapat memberikan anggaran yang baik untuk dokumentasi (terutama menugaskan seorang desainer untuk membuat visual yang berkualitas) dari awal, menambahkan tangkapan layar jauh lebih baik daripada menambahkan apa pun. Namun, visual yang dibuat oleh desainer benar -benar memberikan nuansa premium.
• Dokumentasi untuk mendukung pelacakan tiket .

Ini adalah salah satu fitur Heroic KB Analytics untuk melacak tiket dukungan yang berasal dari dokumentasi. Sangat membantu untuk menemukan konten yang tidak membantu dan ketinggalan zaman.

• FAQ . Pengguna mengajukan banyak pertanyaan yang sering diajukan seperti kebijakan pengembalian dana, atau peningkatan di masa depan, menjawabnya melalui dokumentasi membantu pengguna dengan mudah menemukannya dengan bilah pencarian dan asisten bantuan AI.
• AI membantu asisten . Mirip dengan bar pencarian, AI membantu Asisten membantu pengguna dengan mudah menemukan jawaban atas pertanyaan mereka. Ini dilatih pada konten dokumentasi, jadi jawabannya relevan dan bermanfaat.

Apa yang tidak disukai tentang dokumentasi Herothemes:

Karena Herothemes menawarkan beberapa solusi perangkat lunak, pengelompokan konten dokumentasi sedikit berantakan .

Kami memiliki beberapa panduan untuk membantu Anda membuat situs web dokumentasi dengan WordPress:

• Cara membuat basis pengetahuan wordpress (panduan langkah demi langkah)
• Cara membuat dokumentasi internal

3. Dokumentasi Portofolio Perangkat Lunak Barn2

Barn2 menjual beberapa produk perangkat lunak berdasarkan WordPress dan WooCommerce yang digunakan di lebih dari 90.000 situs web.

Melayani beberapa dokumentasi perangkat lunak dari satu portal bisa menantang, tetapi Barn2 melakukannya dengan indah.

Anda harus melihat contoh Barn2 jika Anda memiliki banyak produk.

Hal -hal yang harus dipelajari dari contoh dokumentasi Barn2:

Barn2 dengan sangat hati -hati membuat halaman dukungan mereka. Yang dapat dilihat dengan keseluruhan fungsionalitas dan kegunaannya.

Saat Anda mengunjungi halaman dukungan mereka, Anda akan menemukan bilah pencarian yang menonjol dengan opsi untuk memilih produk tertentu .

Pertanyaan yang sering diajukan terkait dengan pra-penjualan, lisensi, pembaruan dan masalah teknis. Ini sangat menarik untuk berinteraksi dan memberikan jawaban cepat juga.

Ketika pencarian gagal memberikan hasil apa pun, itu menunjukkan cara untuk mencapai dukungan manusia.

Berbicara tentang dokumentasi perangkat lunak utama:

• Anda akan menemukan semua panduan penting di atas dan pemandu dibagi menjadi beberapa bagian yang berbeda untuk navigasi yang mudah.
• Termasuk tutorial tertulis dan video.
• Dukungan manusia mudah diakses dengan CTA sidebar.
• Blok/desain khusus untuk catatan, tips, pesan peringatan, dan cuplikan kode untuk meningkatkan kemampuan pemindaian.

Apa yang tidak disukai tentang dokumentasi Barn2:

• Tidak ada sistem umpan balik . Meskipun mereka memberikan akses langsung ke dukungan manusia, tidak ada cara bagi mereka untuk mengumpulkan umpan balik real-time dari pengguna. Yang dapat menghasilkan informasi dan tutorial yang sudah ketinggalan zaman.

Barn2 juga menggunakan basis pengetahuan heroik untuk membuat dokumentasi perangkat lunak mereka.

4. Panduan Pengguna iPhone

Ada banyak hal yang disukai dan tidak disukai tentang dokumentasi pengguna iPhone (panduan perangkat lunak iOS).

Ini adalah dokumentasi perangkat lunak yang terlihat mewah dengan instruksi yang mudah diikuti, sesuatu seperti ini yang dapat Anda harapkan dari Apple.

Hal -hal yang harus dipelajari dari contoh dokumentasi iPhone:

Dokumentasi iPhone terlihat menakjubkan .

• Satu tata letak kolom
• Banyak ruang putih
• Paragraf dan konten kecil
• Visual yang indah
• Penggunaan judul, daftar, dan pembagi yang baik

Sebagian besar fokus dari dokumentasi mereka adalah membuat panduan yang menakjubkan dan bermanfaat secara visual.

Ketika Anda menemukan panduan yang relevan, dibutuhkan kurang dari satu menit untuk memindai dan memahami apa yang harus dilakukan.

Dokumentasi iPhone secara khusus dibuat dengan cara ini, sehingga semua orang dapat dengan mudah memahaminya.

Jika Anda ingin membuat dokumentasi perangkat lunak produk, saya akan sangat merekomendasikan membuat panduan pengguna yang mirip dengan iPhone jika Anda memiliki beberapa anggaran untuk dokumentasi.

Selain mempercantik dokumentasi mereka, Apple tidak lupa menggunakan SEO dengan benar . Untuk lebih spesifik:

• Struktur judul dan tajuk
• Interlinking dalam bentuk TOC, posting terkait, navigasi sebelumnya dan berikutnya

Sistem umpan balik panduan luar biasa . Anda mengklik ya atau tidak, dan jika perlu berikan umpan balik juga.

Sistem umpan balik tidak terdengar keren, tetapi ketika Anda memiliki jutaan pengguna yang memberi Anda umpan balik, pelacakan ya atau tidak sederhana benar -benar berguna untuk memeriksa kinerja panduan (Anda tidak dapat membaca semua umpan balik itu, bukan?) .

Apple juga menyediakan panduan berdasarkan versi perangkat lunak (dalam hal ini, versi iOS).

Apa yang tidak disukai tentang dokumentasi iPhone:

Saya memuji banyak tentang dokumentasi iPhone di atas, tetapi ada juga beberapa hal yang menjengkelkan.

Terutama bagian navigasi.

• Daftar isi tidak berguna, karena mencakup semua tautan panduan.
• Ikon pencarian terlalu kecil untuk diperhatikan.

5. Dokumen Desain Perangkat Lunak (contoh internal)

Dokumentasi perangkat lunak dimulai dari gagasan membuat perangkat lunak apa pun.

Misalnya, dokumentasi perangkat lunak awal Anda dapat mencakup:

• Apa kebutuhan dari perangkat lunak
• Cakupan
• Bagaimana itu akan kerjanya
• Referensi

Memiliki informasi terperinci akan membantu menghindari banyak pertemuan di masa depan, melatih karyawan baru, dan membuat pedoman konkret.

Anda dapat belajar banyak dari dokumen desain perangkat lunak Road Trip Advisor.

Ini menguraikan semua persyaratan yang diperlukan untuk mulai membangun perangkat lunak (dalam hal ini, aplikasi web) atau untuk membantu karyawan baru memahami persyaratan dari perangkat lunak.

Selain itu, Anda selalu dapat memperbaikinya selama pengembangan perangkat lunak.

Hal -hal untuk dipelajari dari contoh ini:

• Termasuk informasi dasar tetapi penting seperti tujuan, ruang lingkup dan definisi yang menciptakan pedoman konkret.
• Penggunaan diagram dan grafik visual untuk membantu pengembang lebih memahami persyaratan. Misalnya: Menjelaskan koneksi atau aliran fungsionalitas dengan diagram.

6. Dokumentasi Google

Siapa yang tidak tahu Google? Kami menggunakan perangkat lunak top-of-the-line mereka setiap hari, seperti Chrome, Gmail, Google Maps, Google Drive, atau YouTube.

Mereka tersedia untuk komputer dan perangkat seluler. OS, perangkat, resolusi, dan pengaturan yang berbeda.

Dalam situasi seperti itu, pasti mimpi buruk untuk menciptakan sesuatu yang baik tanpa kekacauan. Dan Google melakukan pekerjaan yang sangat baik dengan dokumentasi mereka .

Hal -hal untuk dipelajari dari dokumentasi perangkat lunak Google:

• Penggunaan tab dan akordeon yang bagus untuk menyederhanakan kelompok konten.

Jika Anda membuat perangkat lunak untuk beberapa perangkat, ini adalah bagaimana Anda dapat menghindari membuat beberapa dokumen.

• Sistem umpan balik yang luar biasa. Mirip dengan beberapa contoh di atas, Google juga menyertakan sistem umpan balik ya/tidak yang juga mengumpulkan umpan balik dari pengguna.

Tapi Google melangkah lebih jauh di sini. Mereka memiliki sistem yang mengumpulkan umpan balik berdasarkan bagian tertentu . Yang sangat intuitif dan berguna.

• Konten cepat . Pergi ke sana, klik ini, unduh, instal, dan booming. Begitulah perasaan tutorial dokumentasi Google yang cepat.
• Bar teratas untuk mengakses pencarian, pusat bantuan, komunitas, dan halaman produk dengan cepat.
• Dokumentasi tersedia dalam berbagai bahasa .

Apa yang tidak disukai tentang dokumentasi Google:

Saya mencoba menemukan banyak hal untuk dikeluhkan di sini, tetapi pada akhirnya saya tidak bisa melakukannya. Google pasti memiliki dokumentasi perangkat lunak yang baik.

Pikiran terakhir

Kami telah membahas banyak contoh berbeda dalam panduan contoh dokumentasi perangkat lunak ini, dan juga berbagi pengalaman pribadi kami.

Berikut beberapa kata terakhir:

1. Saat Anda memulai dengan pembuatan perangkat lunak , buat beberapa panduan internal yang akan menguraikan tujuan, ruang lingkup, fungsionalitas, dan kriteria pelepasan perangkat lunak.
2. Bangun portofolio dokumentasi Anda saat Anda mengembangkan perangkat lunak . Misalnya, dokumentasi API, dan dokumentasi teknis.
3. Sebelum meluncurkan perangkat lunak , buat dokumentasi pengguna yang mencakup panduan pengaturan, menggunakan kasus, ikhtisar fungsionalitas, dan pertanyaan yang sering diajukan.
4. Setelah diluncurkan , buat tutorial untuk mengatasi masalah pengguna yang paling umum dan meningkatkan dokumentasi lama Anda.

Dokumentasi bukan lelucon; Ini dapat menyelamatkan Anda dari proses pembangunan kembali atau desain ulang perangkat lunak yang menghebohkan. Saya dapat membantu Anda menawarkan pengalaman pelanggan yang lebih baik dan mempertahankan pelanggan.

Jika Anda mencari solusi dokumentasi perangkat lunak , basis pengetahuan heroik memiliki segalanya untuk ditawarkan yang kita bahas dalam panduan ini.

Cobalah!