Terorganisir! Cara Membuat Panduan Gaya Basis Pengetahuan

Menulis basis pengetahuan sudah cukup sulit. Jadi saya minta maaf atas apa yang akan saya lakukan di posting ini. Saya akan memberi tahu Anda bahwa ini bukan hanya tentang ide-ide dalam basis pengetahuan Anda, tetapi juga tentang bagaimana Anda menyajikannya.

Lihat, di luar gagasan itu, Anda perlu memastikan bahwa Anda selalu:

• Menggunakan nada yang tepat
• Secara konsisten memformat semuanya sama

Yang, untuk alasan yang akan saya jelaskan di bagian selanjutnya, sebenarnya sangat sulit. Di situlah panduan gaya basis pengetahuan berperan.

Mengapa Basis Pengetahuan Anda Mungkin Berantakan dengan Gaya yang Berbeda

Jangan terlalu khawatir jika basis pengetahuan Anda adalah campuran gaya yang berbeda. Itu terjadi pada banyak perusahaan, biasanya karena salah satu dari dua alasan (atau terkadang keduanya!).

Pertama, jika Anda adalah bagian dari tim, Anda mungkin memiliki orang yang berbeda yang menulis dokumen dukungan. Jadi jika:

• Jim menulis Artikel A
• Sally menulis Artikel B

Artikel-artikel tersebut mungkin akan memiliki gaya dan format yang sangat berbeda…kecuali jika Anda memiliki panduan gaya yang telah ditentukan sebelumnya.

Sekarang, jika Anda bukan bagian dari sebuah tim, Anda mungkin berkata, “Saya seorang serigala – saya menulis semuanya sendiri. Jadi saya tidak perlu menuliskan apa pun di atas kertas – itu semua saya!”

Dan itu mungkin terjadi ... jika Anda menulis semua artikel basis pengetahuan Anda dalam sekali duduk.

Tapi kita berdua tahu itu bukan cara kerja biasanya, kan? Anda mungkin menulis banyak artikel basis pengetahuan saat pertama kali merilis produk Anda.

Tapi kemudian, tiga bulan kemudian, Anda merilis fitur baru. Sekarang Anda harus menulis entri basis pengetahuan untuk fitur baru itu dan… ingatan manusia tidak begitu bagus . Ada kemungkinan besar Anda akhirnya melakukan sesuatu yang berbeda, bahkan jika Anda tidak mencobanya.

Jadi, apakah Anda solo atau bagian dari tim, ada baiknya untuk meletakkan panduan gaya basis pengetahuan Anda di atas kertas.

Apakah Perusahaan Benar-Benar Melakukan Ini? Apakah Panduan Gaya Basis Pengetahuan adalah Hal yang Nyata?

Oke, saya akan memberi tahu Anda cara membuat panduan gaya Anda sebentar lagi. Tapi pertama-tama, saya ingin memimpin dengan beberapa contoh perusahaan yang benar-benar melakukan ini. Ini mencapai dua tujuan:

• Ini menunjukkan kepada Anda bahwa saya tidak hanya mengada-ada untuk membuat lebih banyak konten blog
• Ini memberi Anda contoh kehidupan nyata yang dapat Anda tarik untuk panduan gaya Anda sendiri.

Mari kita lihat Mozilla dulu. Mozilla memiliki seluruh entri pada panduan gaya untuk basis pengetahuan mereka. Karena Mozilla adalah open source, sangat penting bagi mereka untuk memiliki panduan gaya, dengan kata-kata mereka sendiri, "membuat Basis Pengetahuan dukungan Firefox konsisten, menghasilkan basis pengetahuan, yang mudah dibaca dan berkontribusi.". Mudah dibaca? Kedengarannya seperti tujuan yang baik untuk basis pengetahuan Anda, bukan?

Panduan ini mendalam, membawa Anda melalui segala hal mulai dari kapitalisasi, spasi putih, hingga koma serial.

Selanjutnya, Voice & Tone MailChimp adalah bacaan berharga lainnya. Meskipun tidak 100% terfokus pada basis pengetahuan, ia memiliki sejumlah entri untuk basis pengetahuan dan konten tutorial:

Sementara panduan gaya Mozilla lebih fokus pada gaya dan pemformatan, MailChimp memilih untuk lebih fokus pada, yah, suara dan nada, daripada pemformatan seluk beluk.

Cara Membuat Panduan Gaya untuk Basis Pengetahuan Anda

Saya memberikan beberapa contoh kepada Anda, tetapi saya belum memberi Anda proses untuk benar-benar membuat panduan gaya basis pengetahuan Anda sendiri. Jadi mari kita perbaiki itu!

Gunakan Orang yang Konsisten

Pernahkah Anda membaca artikel di mana penulisnya bolak-balik antara "Saya" dan "Kami"? Saya pernah, dan kami dapat memberi tahu Anda bahwa ini sangat membingungkan.

Jadi, jika Anda akan menggunakan orang pertama – pilih salah satu dan konsistenlah. Bahkan jika Anda seorang solo, Anda masih dapat memilih untuk menggunakan "kami". Terserah kamu! Gunakan saja yang sama.

Selain itu, Anda bahkan tidak perlu menggunakan orang pertama. Anda dapat memilih untuk menghindari "saya" dan "kami" sama sekali.

Tidak ada jawaban yang benar di sini – ini hanya tentang konsistensi.

Standarisasi Pemformatan Anda

Jika Anda membaca panduan template artikel basis pengetahuan utama kami, Anda tahu bahwa basis pengetahuan yang baik menggunakan banyak instruksi dengan langkah-langkah kecil. Dan instruksi itu, pada titik tertentu, akan menyertakan bahasa seperti:

Klik File .

Jadi begitu:

• Klik File
• Klik pada "Berkas"
• Klik File

Dan ketika Anda benar-benar menulis daftar Anda, apakah itu:

• Langkah 1: Klik ini
• Langkah 2: Klik itu

Atau seperti ini:

• Klik ini
• Klik itu

Sekali lagi – Anda dapat memilih yang paling Anda sukai – tetapi mana pun yang Anda pilih, gunakan secara konsisten di seluruh basis pengetahuan Anda.

Ada pilihan pemformatan lain yang perlu Anda buat juga – panduan gaya Mozilla memberi Anda ide bagus tentang segala hal yang akan dibahas, tetapi berikut adalah beberapa ide awal:

• Kapitalisasi heading – apakah Anda akan menggunakan kasus kalimat atau Judul Kasus?
• Angka – apakah 10 atau sepuluh?
• Singkatan – jangan atau tidak?
• Akronim – CDN atau jaringan pengiriman konten?

Jika Anda menggunakan salah satu tema atau plugin WordPress basis pengetahuan kami, kode pendek dan opsi pemformatan bawaan kami dapat membantu Anda tetap konsisten dalam hal pemformatan

Dapatkan Suara yang Tepat

Terakhir, Anda harus melampaui format dan standarisasi suara Anda.

Apakah Anda teman pelanggan Anda? Atau apakah Anda Spock dari Star Trek, tanpa perasaan mengeluarkan kebijaksanaan keras yang dingin?

Dalam alasan, keduanya baik-baik saja. Asalkan konsisten.

Secara umum, Anda harus memastikan untuk mengikuti tip panduan basis pengetahuan MailChimp. Saya menyarankan mereka bukan hanya karena MailChimp benar-benar menerbitkan panduan mereka, tetapi juga karena saya pikir MailChimp memiliki salah satu basis pengetahuan terbaik di luar sana.

Saran mereka adalah ini:

• Selalu membuat prioritas pertama Anda untuk menjawab pertanyaan dan menginformasikan pembaca Anda. Lelucon kadang baik-baik saja, tetapi tidak jika itu mengalihkan perhatian dari tujuan penting itu.
• Hindari berbicara seperti seorang pemasar – Anda hanya mencoba membantu.

Di mana Menyimpan Panduan Gaya Anda?

Anda seharusnya tidak hanya membuat keputusan ini. Anda juga harus benar-benar, lho, menuliskannya di tempat yang aman.

Secara pribadi, sebagian besar panduan gaya yang saya gunakan adalah dokumen Google Documents. Dengan begitu, Anda dapat dengan mudah membagikan panduan gaya Anda dan mengaksesnya dari komputer yang berbeda.

Tetapi jika Anda lebih suka metode lain, gunakan apa yang Anda kenal. Satu-satunya hal yang sangat penting adalah ini:

Anda memiliki salinan panduan gaya basis pengetahuan Anda yang disimpan di tempat yang aman di mana Anda, atau orang lain, dapat mengaksesnya saat Anda membutuhkan penyegaran tentang cara memformat basis pengetahuan Anda.

Jadi, tuliskan di atas kertas dan mulailah membuat artikel basis pengetahuan yang lebih konsisten!