Artikel panduan (how-to) adalah salah satu format konten dengan lalu lintas tertinggi di web. Dengan Trupeer, Anda bisa menghemat waktu berjam-jam untuk menulis konten how-to dengan memulai dari template artikel how-to gratis, menyesuaikannya dengan panduan brand Anda, lalu mengubah setiap artikel menjadi tutorial video yang menarik sehingga pembaca memiliki cara kedua untuk belajar.

Sebuah artikel how-to menempatkan pembaca pada kondisi yang sangat spesifik. Mereka sedang berada di tengah-tengah sesuatu, tidak berjalan seperti yang diharapkan, dan mereka sudah menghabiskan waktu lebih lama daripada yang mereka inginkan. Mereka tidak membaca—mereka sedang memindai bagian yang akan membuat masalah mereka teratasi.

Hampir semua aturan tentang cara menulisnya berasal dari hal itu.

Unduh template artikel how-to

Gratis, bisa diedit, tanpa watermark.

Tiga cara artikel how-to gagal

Setiap kegagalan adalah salah satu dari ini, dan masing-masing memerlukan perbaikan yang berbeda.

Kebanyakan saran menulis membahas gerbang ketiga. Kebanyakan artikel gagal di dua gerbang pertama.

Gerbang satu: judul

Jika judul tidak sesuai dengan kata-kata yang akan digunakan pembaca, artikel tersebut tidak dianggap ada—setidaknya menurut mereka.

Tulis tugasnya, bukan fiturnya. "Cara mengekspor laporan Anda sebagai CSV" lebih baik daripada "Menggunakan modul ekspor". Orang mencari apa yang ingin mereka lakukan.

Gunakan kosakata mereka. Nama internal Anda untuk sebuah fitur bukanlah yang disebut pelanggan. Ambil frasa dari tiket dukungan dan pencarian situs.

Mulai dengan kata kerja. "Cara mengatur ulang kata sandi Anda" dipindai lebih cepat daripada "Reset kata sandi: panduan".

Spesifik agar terasa eksklusif. "Cara menambahkan pengguna" menjadi ambigu jika Anda memiliki tiga jenis pengguna. "Cara menambahkan pengguna admin ke workspace" tidak.

Satu tugas per judul. Jika judul berisi "dan", berarti ada dua artikel.

Gerbang dua: pembuka

Pembaca sudah mendarat. Mereka punya waktu sekitar lima detik untuk memutuskan apakah ini halaman yang tepat.

Bagian pembuka menjawab tiga pertanyaan sebelum langkah dimulai.

Apa yang dilakukan artikel ini. Satu kalimat. "Artikel ini menunjukkan cara menghubungkan sistem akuntansi Anda agar invoice tersinkron otomatis."

Untuk siapa. Apa pun peran, izin, atau persyaratan paket. "Anda perlu akses admin untuk melakukannya."

Apa yang perlu Anda siapkan terlebih dahulu. Prasyarat, disebutkan sebelum langkah pertama, bukan ditemukan di langkah keempat.

Yang terakhir mencegah frustrasi paling umum dalam dokumentasi teknis: mendapatkan tiga langkah lalu menemukan bahwa Anda membutuhkan sesuatu yang tidak Anda miliki. Prasyarat harus ada di bagian paling atas, selalu.

Tambahkan perkiraan waktu jika lebih dari beberapa menit. "Ini memakan waktu sekitar 15 menit" membantu seseorang memutuskan apakah akan mulai sekarang atau kembali nanti.

Gerbang tiga: langkah

Di sinilah pembaca akan menyelesaikan atau menyerah.

• Satu tindakan per langkah. Jika satu langkah berisi "dan kemudian", pisahkan.

• Mulai setiap langkah dengan kata kerja. "Klik Settings" bukan "Anda sebaiknya lalu klik Settings".

• Sebutkan di mana sebelum apa. "Di pojok kanan atas, klik Export" memberi tahu mereka harus melihat ke mana terlebih dahulu.

• Namai apa yang akan mereka lihat. Label tombol yang persis, dengan kapitalisasi yang persis. Jika tombol bertuliskan "Save & close", tulislah itu.

• Berikan nomor. Poin-poin menyiratkan urutan tidak penting.

• Usahakan di bawah sepuluh langkah bila memungkinkan. Tugas yang lebih panjang dipecah menjadi fase dengan subjudul.

• Tampilkan hasilnya. Setelah langkah terakhir, jelaskan apa yang seharusnya benar sekarang. "Sinkronisasi berjalan setiap jam. Anda akan melihat waktu sinkronisasi terakhir di halaman integrations."

• Jangan jelaskan alasan di tengah tugas. Pembaca sedang menjalankan, bukan belajar. Masukkan penalaran dalam catatan, atau dalam artikel konsep yang terpisah.

Cara menyesuaikan template ini di Trupeer

Langkah 1: Buka Bagian Templates

Buka bagian Templates dari navigasi utama.

Langkah 2: Pilih dan Buka Template

Klik salah satu template yang ingin Anda gunakan untuk membukanya.

Langkah 3: Perluas Tampilan Template

Jika diperlukan, perluas tampilan template untuk melihat tata letak dan detail secara jelas.

Langkah 4: Edit Template

Klik Edit untuk mulai memodifikasi template yang dipilih.

Di dalam editor, Anda bisa:

• Menambahkan bagian baru

• Menentukan atau memperbarui aturan pemformatan

• Menambahkan logo dan menyesuaikan posisinya serta pengaturan terkait

Langkah 5: Simpan Template yang Anda Sesuaikan

Setelah membuat semua perubahan yang diperlukan, klik Save untuk menyimpan template yang diperbarui sebagai milik Anda.

Langkah 6: Pratinjau dan Penyempurnaan Template

Saat Anda ingin melihat seperti apa tampilan template yang Anda sesuaikan, buka Preview.

Dari layar pratinjau, Anda bisa terus melakukan penyesuaian langsung jika diperlukan, sehingga template tampil persis seperti yang Anda inginkan.

Dengan template artikel how-to, Anda bisa:

• Menghemat waktu berjam-jam untuk menulis: Lewati halaman kosong dengan struktur yang dibuat khusus untuk konten how-to.

• Rangking di pencarian: How-to yang tersusun rapi dengan skema HowTo akan mendapat peringkat yang baik di Google.

• Tetap sesuai brand: Terapkan logo, font, dan warna Anda menggunakan brand kit Trupeer.

• Kurangi beban dukungan: Artikel how-to yang jelas membantu pengguna melakukan self-serve.

• Tambahkan video walkthrough: Sematkan tutorial video untuk langkah yang sulit dijelaskan dalam teks.

• Jangkau pembaca global: Terjemahkan artikel how-to ke 65+ bahasa hanya dengan satu klik.

Template artikel how-to

Sepuluh bagian, empat di antaranya singkat. Bagian utamanya adalah langkah dan troubleshooting.

Screenshot

Perbedaan antara artikel how-to yang bisa digunakan dan tumpukan instruksi.

• Satu screenshot per langkah jika antarmukanya tidak jelas. Tidak semua langkah, atau artikel menjadi tidak mudah dipindai.

• Pangkas ke area yang relevan. Tangkapan layar penuh membuat pembaca harus mencari bagian yang Anda maksud.

• Berikan anotasi secukupnya. Satu kotak atau panah. Anotasi yang terlalu banyak saling bersaing.

• Tampilkan status, bukan hanya lokasi. Jika sebuah langkah mengubah sesuatu, perbandingan sebelum dan sesudah lebih berharga daripada satu gambar saja.

• Hindari data pribadi atau data pelanggan. Gunakan akun demo, dan periksa tab browser serta notifikasi di sudut tangkapan layar Anda.

• Catat biaya pemeliharaannya. Screenshot menjadi usang setiap kali ada perubahan antarmuka, dan screenshot yang usang mengurangi kepercayaan pada seluruh artikel. Ini adalah argumen terkuat untuk merekam daripada sekadar menangkap layar.

Troubleshooting

Bagian yang memisahkan artikel yang kompeten dari artikel yang benar-benar berguna, dan juga bagian yang paling sering diabaikan.

Daftarkan tiga atau empat hal yang benar-benar salah, dengan kata-kata pembaca, beserta solusinya.

Tidak ada yang muncul setelah langkah 4. Biasanya berarti koneksi belum selesai memberi otorisasi. Tunggu sebentar lalu muat ulang. Jika masih kosong, akun mungkin tidak memiliki izin yang diperlukan.

Tombolnya berwarna abu-abu. Anda memerlukan akses admin untuk ini. Tanyakan kepada siapa pun yang menyiapkan workspace Anda.

Berhasil, tetapi datanya terlihat salah. Periksa filter rentang tanggal, yang default-nya adalah bulan berjalan.

Ambil sumbernya dari tiket dukungan, bukan dari imajinasi. Jika empat orang menghubungi Anda dengan masalah yang sama setelah mengikuti artikel, masalah itu harus ada di artikel.

Yang lemah dan yang lebih baik

Lemah: Pengguna dapat mengonfigurasi pengaturan ekspor melalui modul pelaporan agar memperoleh data dalam berbagai format sesuai kebutuhan.

Lebih baik: Untuk mengekspor laporan sebagai CSV: 1. Buka laporan. 2. Di pojok kanan atas, klik Export. 3. Pilih CSV lalu klik Download. File muncul di folder unduhan Anda, dan mencakup setiap kolom yang saat ini terlihat di laporan.

Lemah: Langkah 3: Konfigurasikan pengaturan integrasi dengan tepat dan simpan perubahan Anda.

Lebih baik: 3. Masukkan API key dari sistem akuntansi Anda. 4. Atur Sync frequency menjadi Hourly. 5. Klik Save & test. Anda harus melihat label Connected berwarna hijau.

Versi pertama adalah satu langkah yang melakukan tiga hal tanpa cara untuk mengetahui apakah itu berhasil. Versi kedua adalah tiga langkah dengan hasil yang bisa diverifikasi.

Judul lemah: Panduan Konfigurasi Integrasi

Judul lebih baik: Cara menghubungkan sistem akuntansi Anda

Pembuka lemah: Artikel ini memberikan gambaran umum tentang fungsionalitas ekspor yang tersedia di dalam platform.

Pembuka lebih baik: Artikel ini menunjukkan cara mengekspor laporan sebagai CSV, Excel, atau PDF. Anda perlu akses view ke laporan tersebut. Memakan waktu sekitar satu menit.

Jenis artikel dokumentasi

How-to adalah salah satu dari empat jenis, dan mencampurnya adalah kesalahan struktural yang paling umum dalam dokumentasi.

Kesalahannya adalah menjelaskan konsep di dalam how-to. Pembaca sedang menjalankan dan tidak ingin latar belakangnya. Tautkan ke artikel konsep sebagai gantinya, dan pastikan langkah-langkahnya tetap bersih.

Kesalahan kebalikannya adalah artikel konsep yang menyembunyikan tiga langkah di tengah, sehingga tidak ada yang akan menemukannya saat mereka membutuhkannya.

Panjang artikel

Lebih pendek daripada yang disarankan oleh insting. Artikel how-to seharusnya mencakup satu tugas dan berhenti.

Jika melebihi sepuluh langkah, cari pemisahan yang alami. "Cara menyiapkan X" sering kali sebenarnya "Cara membuat X", "Cara mengonfigurasi X" dan "Cara mengundang orang ke X", yang merupakan tiga artikel yang masing-masing bisa ditemukan secara independen dan ditautkan berurutan.

Artikel panjang juga gagal di gerbang satu, karena satu artikel yang mencakup enam tugas hanya bisa memiliki satu judul, sehingga lima tugas lainnya tidak bisa ditemukan.

Format

Word untuk menyusun dan meninjau, karena perubahan terlacak dan komentar membuat siklus peninjauan lebih mudah dikelola. Di sinilah sebagian besar artikel seharusnya ditulis sebelum mendekati sistem penerbitan apa pun.

PDF untuk apa pun yang dicetak, dibagikan saat pelatihan, atau diperlukan secara offline. Ini juga format yang tepat untuk panduan yang ditujukan kepada pelanggan yang Anda lampirkan ke email.

PowerPoint ketika how-to berubah menjadi pelatihan. Satu langkah per slide, screenshot di setiap slide, bekerja dengan baik untuk sesi walkthrough.

Help centre atau knowledge base Anda untuk apa pun yang ditujukan kepada pelanggan dan perlu bisa ditemukan serta dicari, yang sebagian besar memang begitu. Word dan PDF adalah format penyusunan dan distribusi, bukan format penerbitan.

Memelihara artikel

Dokumentasi menurun secara perlahan, dan dokumentasi yang usang lebih buruk daripada tidak ada karena orang mengikutinya dan gagal.

Tetapkan pemilik untuk setiap artikel. Catat versi produk yang menjadi acuan saat artikel ditulis. Tinjau setelah setiap rilis yang memengaruhi fitur, dan jika tidak, tinjau pada siklus yang tetap.

Sinyal pemeliharaan yang paling dapat diandalkan adalah tiket dukungan tentang sesuatu yang dicakup artikel. Itu berarti salah satu dari dua hal: artikelnya salah, atau artikelnya benar tetapi tidak bisa ditemukan. Keduanya layak diperbaiki, dan keduanya tidak terlihat kecuali ada seseorang yang memantaunya.

Screenshot adalah elemen yang paling membutuhkan pemeliharaan, sehingga perlu dipertimbangkan berapa banyak yang Anda gunakan dan bagaimana cara Anda membuatnya.

Mengukur apakah artikel berhasil

• Views, yang memberi tahu apakah artikel tersebut bisa ditemukan.

• Tiket dukungan dengan topik yang sama setelah publikasi. Seharusnya menurun. Jika tidak, artikel tidak bekerja atau tidak bisa ditemukan.

• Istilah pencarian tanpa hasil, yang menunjukkan artikel apa yang hilang.

• Waktu di halaman, ditafsirkan dengan hati-hati. Waktu yang lama bisa berarti menyeluruh atau membingungkan.

• Umpan balik artikel, jika help centre Anda memilikinya, meskipun tingkat respons biasanya rendah.

• Deflection, artinya orang yang melihat artikel lalu tidak menghubungi dukungan.

Angka tunggal yang paling berguna adalah volume dukungan pada topik sebelum dan sesudah publikasi. Sisanya hanyalah proksi.

Cara menulis artikel how-to

1. Cari tahu apa yang benar-benar ditanyakan orang, dari tiket dukungan dan pencarian situs. Jangan menebak topiknya.

2. Tulis judul terlebih dahulu, sebagai tugas dengan kata-kata pembaca. Jika Anda tidak bisa, berarti ruang lingkupnya tidak jelas.

3. Lakukan tugasnya sendiri saat menulis, atau tonton seseorang melakukannya. Artikel yang ditulis dari ingatan melewatkan langkah-langkah.

4. Daftarkan prasyarat saat Anda menemukannya.

5. Tulis satu tindakan per langkah, kata kerja di awal, dengan label antarmuka yang persis.

6. Rekam atau tangkap saat proses berlangsung, bukan setelahnya dari ingatan.

7. Nyatakan hasil yang diharapkan.

8. Tambahkan troubleshooting dari tiket nyata.

9. Minta seseorang yang belum familiar mengikutinya tanpa bantuan. Setiap pertanyaan yang mereka ajukan adalah cacat.

10. Publikasikan, lalu pantau volume dukungan pada topik tersebut.

Langkah kesembilan adalah satu-satunya pengujian yang benar. Artikel yang ditinjau oleh seseorang yang sudah tahu tugasnya akan selalu terlihat baik.

Praktik terbaik

• Judul berbasis tugas dengan kosakata pembaca.

• Prasyarat sebelum langkah satu, selalu.

• Satu tindakan per langkah, kata kerja di awal.

• Label antarmuka yang persis, kapitalisasi yang persis.

• Screenshot dipangkas dan diberi anotasi secukupnya.

• Hasil yang diharapkan dinyatakan setelah langkah terakhir.

• Troubleshooting bersumber dari tiket nyata.

• Satu tugas per artikel, di bawah sepuluh langkah.

• Konsep ditautkan, bukan disematkan.

• Diuji oleh seseorang yang belum pernah melakukan tugas tersebut.

Kesalahan umum

• Judul dinamai berdasarkan fitur, bukan tugas.

• Prasyarat ditemukan di langkah empat.

• Langkah berisi tiga tindakan masing-masing.

• Instruksi yang samar seperti "konfigurasikan pengaturan dengan tepat".

• Label antarmuka diparafrase, bukan dikutip.

• Screenshot layar penuh tanpa pemangkasan.

• Data pelanggan terlihat di screenshot.

• Tidak ada hasil yang diharapkan, sehingga pembaca tidak bisa memastikan apakah berhasil.

• Tidak ada bagian troubleshooting.

• Konsep dijelaskan di dalam langkah-langkah.

• Enam tugas dalam satu artikel, lima di antaranya tidak bisa ditemukan.

• Ditulis dari ingatan, bukan dengan melakukan tugasnya.

• Ditinjau hanya oleh orang-orang yang sudah tahu caranya.

• Screenshot tidak pernah diperbarui setelah perubahan antarmuka.

Rekam tugasnya, bukan menuliskannya dari ingatan

Buka template di Trupeer AI, terapkan brand kit Anda agar artikel sesuai dengan dokumentasi Anda, lalu edit bagian mana pun secara langsung. Penyiapannya ada di panduan template.

Dua hal membuat artikel how-to menjadi mahal. Menulis dari ingatan melewatkan langkah-langkah yang sebenarnya Anda lakukan secara otomatis, yaitu tepat di bagian tempat pembaca biasanya tersangkut. Dan screenshot membutuhkan waktu lama untuk dibuat serta menjadi usang setiap kali ada perubahan antarmuka, itulah sebabnya banyak artikel menampilkan versi produk yang sudah tidak ada.

Rekaman menyelesaikan keduanya. Lakukan tugasnya sekali, lalu Trupeer AI menghasilkan artikel tertulis dengan langkah-langkah dalam urutan yang benar-benar terjadi dan screenshot yang ditangkap secara otomatis, plus video walkthrough yang dinarasikan dari proses yang sama. Saat antarmuka berubah, rekam ulang, bukan screenshot ulang.

Terjemahkan ke 65+ bahasa, dan simpan set tersebut di knowledge base Anda agar pembaca dapat menemukannya.

Rekam. Branding. Terjemahkan. Trupeer-kan.

Pertanyaan yang Sering Diajukan

Apakah ada template artikel how-to gratis di Word?

Ya. Word adalah format utama dan tempat yang tepat untuk menyusun, karena proses review dengan tracked changes lebih mudah di sana dibandingkan di sistem penerbitan. Template ini mencakup struktur lengkap dengan prompt di setiap bagian. Unduhan gratis, tanpa pendaftaran, tanpa watermark.

Apakah ada template artikel di Word yang gratis untuk diunduh?

Ya, dan template ini cocok untuk semua artikel instruksional, tidak hanya yang langkah demi langkah. Strukturnya berlaku untuk artikel konsep, referensi, dan troubleshooting dengan penyesuaian minor.

Apakah ada template artikel how-to gratis di PDF?

Ya, dalam format panduan yang bisa dicetak, cocok untuk materi pelatihan, paket onboarding, dan apa pun yang dibutuhkan pelanggan secara offline.

Apakah ada template artikel di PDF?

Ya, tersedia versi kosong dan contoh yang sudah selesai, sehingga Anda bisa melihat artikel how-to yang sudah jadi sebelum menulis versi Anda sendiri.

Apakah ada template artikel how-to gratis di PPT atau PowerPoint?

Ya. Versi PowerPoint mengubah how-to menjadi walkthrough pelatihan, satu langkah per slide dengan ruang untuk screenshot di setiap slide. Ini bekerja dengan baik untuk sesi langsung, dan kurang cocok sebagai materi referensi setelahnya, jadi sebagian besar tim juga membutuhkan versi Word.

Bisakah saya mengunduh template artikel how-to gratis?

Ya, setiap format bisa diunduh secara gratis tanpa memerlukan akun dan tanpa atribusi.

Apa template artikel how-to gratis terbaik?

Yang mencakup prasyarat dan troubleshooting. Kebanyakan template memberi Anda judul dan langkah bernomor, yang merupakan bagian mudah. Pembaca menyerah karena mereka menemukan prasyarat yang hilang di langkah empat atau mengalami masalah yang tidak disebutkan dalam artikel, dan dua bagian itulah yang mencegah hal tersebut.

Apa itu artikel how-to?

Artikel instruksional singkat yang membahas satu tugas spesifik, ditulis untuk seseorang yang ingin melakukannya sekarang juga. Artikel ini berbeda dari tutorial, yang mengajarkan dari nol, dan dari artikel konsep, yang menjelaskan cara kerja sesuatu.

Apa saja yang harus dimuat dalam artikel how-to?

Judul berbasis tugas, ringkasan satu kalimat, untuk siapa termasuk izin apa pun yang diperlukan, prasyarat sebelum langkah satu, waktu yang dibutuhkan, langkah bernomor dengan satu tindakan setiap langkah, hasil yang diharapkan, troubleshooting untuk tiga atau empat masalah umum, artikel terkait, serta metadata yang menunjukkan pemilik dan tanggal peninjauan terakhir.

Bagaimana cara menulis artikel how-to yang baik?

Tulis judul sebagai tugas dengan kata-kata pembaca, lakukan tugasnya sendiri saat menulis daripada mengandalkan ingatan, daftarkan prasyarat saat Anda menemukannya, gunakan satu tindakan per langkah dengan label antarmuka yang persis, nyatakan apa yang seharusnya benar di akhir, dan tambahkan troubleshooting dari tiket dukungan nyata. Lalu minta seseorang yang belum familiar mengikutinya tanpa bantuan.

Seberapa panjang artikel how-to seharusnya?

Satu tugas, idealnya di bawah sepuluh langkah. Jika lebih panjang, biasanya itu beberapa tugas yang masing-masing akan lebih mudah ditemukan sebagai artikel terpisah yang ditautkan berurutan. Artikel panjang juga gagal karena hanya bisa memiliki satu judul, sehingga tugas lain di dalamnya tidak terlihat oleh pencarian.

Apa perbedaan antara how-to dan tutorial?

How-to ditujukan untuk seseorang yang sudah tahu apa yang mereka inginkan dan membutuhkan langkah spesifik. Tutorial mengajari pemula, biasanya dengan contoh yang dikerjakan dan penjelasan yang lebih banyak. Perbedaan kondisi pembaca: pembaca how-to tidak sabar dan sedang berada di tengah tugas, sedangkan pembaca tutorial sudah meluangkan waktu untuk belajar.

Apakah artikel how-to perlu menyertakan screenshot?

Untuk apa pun yang antarmukanya tidak jelas, ya—dipangkas ke area yang relevan dengan anotasi ringan. Tidak untuk setiap langkah, atau artikel berhenti menjadi mudah dipindai. Perlu diingat bahwa screenshot adalah elemen dokumentasi yang paling membutuhkan pemeliharaan dan akan menjadi usang setiap kali ada perubahan antarmuka, sehingga sebaiknya dipertimbangkan sebelum menambahkan dua belas screenshot.

Seberapa sering artikel how-to harus ditinjau?

Setelah setiap rilis yang memengaruhi fitur, dan jika tidak, pada siklus yang tetap—biasanya setiap enam hingga dua belas bulan. Pemicu yang paling berguna adalah tiket dukungan tentang sesuatu yang sudah dicakup artikel, yang berarti artikelnya salah atau tidak bisa ditemukan.

Bisakah saya menyesuaikan template artikel how-to ini?

Ya, setiap versi sepenuhnya bisa diedit. Sesuaikan bagian-bagiannya dengan standar dokumentasi Anda, meskipun prasyarat dan troubleshooting adalah dua hal yang layak dipertahankan apa pun, karena keduanya membahas dua poin di mana pembaca paling sering meninggalkan sebuah artikel.

Template terkait

• Template dokumentasi teknis

• Template knowledge base

• Template artikel knowledge base

• Template SOP

• Template instruksi kerja

• Template job aid

• Template user guide

• Template dokumentasi perangkat lunak

• Template halaman FAQ