Organize Olun! Bilgi Bankası Stil Kılavuzu Nasıl Oluşturulur

Bir bilgi tabanı yazmak zaten yeterince zor. Bu yüzden bu yazıda yapacağım şey için özür dilerim. Size bunun sadece bilgi tabanınızdaki fikirlerle ilgili olmadığını, aynı zamanda onları nasıl sunduğunuzla da ilgili olduğunu söyleyeceğim.

Bakın, bu fikirlerin ötesinde, her zaman şunları yaptığınızdan emin olmanız gerekir:

• Uygun tonu kullanma
• Her şeyi sürekli olarak aynı biçimlendirme

Bu, bir sonraki bölümde açıklayacağım nedenlerden dolayı, aslında şaşırtıcı derecede zordur. İşte burada bir bilgi tabanı stil kılavuzu devreye giriyor.

Bilgi Tabanınız Neden Farklı Tarzlardan Oluşan Bir Karmaşa Olabilir?

Bilgi tabanınız farklı tarzlardan oluşan bir karmakarışıksa çok fazla endişelenmeyin. Genellikle iki nedenden biri (veya bazen her ikisi de!) nedeniyle bir ton şirketin başına gelir.

İlk olarak, bir ekibin parçasıysanız, destek belgeleri yazan farklı kişiler olabilir. Yani:

• Jim, Madde A'yı yazar
• Sally Madde B'yi yazıyor

Önceden tanımlanmış bir stil kılavuzunuz yoksa, bu makaleler muhtemelen çok farklı stillere ve biçimlendirmeye sahip olacak.

Şimdi, eğer bir ekibin parçası değilseniz, muhtemelen “Yalnız bir kurdum – her şeyi kendim yazıyorum. Bu yüzden kağıda hiçbir şey yazmama gerek yok – hepsi benim!”

Ve durum böyle olabilir… eğer tüm bilgi bankası makalelerinizi bir oturuşta yazdıysanız.

Ama işlerin genelde böyle yürümediğini ikimiz de biliyoruz, değil mi? Ürününüzü ilk piyasaya sürdüğünüzde muhtemelen bir yığın bilgi bankası makalesi yazdınız.

Ancak üç ay sonra yeni bir özellik yayınlarsınız. Şimdi bu yeni özellik için bilgi tabanı girişini yazmanız gerekiyor ve… insan hafızaları o kadar iyi değil . Denemeseniz bile, farklı bir şey yapma şansınız var.

Bu nedenle ister tek başınıza, ister bir ekibin parçası olun, bilgi tabanı stil kılavuzunuzu kağıda dökmek işe yarar.

Şirketler Gerçekten Bunu Yapıyor mu? Bilgi Bankası Stil Rehberi Gerçek Bir Şey mi?

Tamam, birazdan stil rehberinizi nasıl oluşturacağınızı anlatacağım. Ama önce, bunu gerçekten yapan şirketlerden bazı örnekler vermek istiyorum. Bu iki amacı gerçekleştirir:

• Size daha fazla blog içeriği oluşturmak için bir şeyler uydurmadığımı gösteriyor.
• Size kendi stil rehberiniz için çekebileceğiniz gerçek hayattan bir örnek verir.

Önce Mozilla'ya bakalım. Mozilla, bilgi tabanı için stil kılavuzunda tam bir girişe sahiptir. Mozilla açık kaynak olduğundan, kendi ifadeleriyle "Firefox desteği Bilgi Bankası'nı tutarlı hale getirmek, bu da okunması ve katkıda bulunması kolay bir bilgi tabanı ile sonuçlanması" için bir stil kılavuzuna sahip olmaları özellikle önemlidir. Okuması kolay? Bu, bilgi tabanınız için iyi bir hedef gibi görünüyor, değil mi?

Kılavuz derinlere iner ve sizi büyük harf kullanımından boşluklara ve seri virgüllere kadar her şeye götürür.

Sırada, MailChimp'in Sesi ve Tonu, okumaya değer başka bir kitap. %100 bilgi tabanlarına odaklanmasa da, hem bilgi tabanı hem de eğitim içeriği için bir dizi girişe sahiptir:

Mozilla'nın stil kılavuzu stil ve biçimlendirmeye daha fazla odaklanırken, MailChimp, esaslı biçimlendirmeden çok ses ve tona odaklanmayı tercih ediyor.

Bilgi Tabanınız İçin Stil Rehberi Nasıl Oluşturulur

Size birkaç örnek verdim, ancak size kendi bilgi tabanı stil kılavuzunuzu gerçekten oluşturmanız için henüz bir süreç vermedim. Öyleyse düzeltelim!

Tutarlı Bir Kişi Kullanın

Yazarın “Ben” ve “Biz” arasında gidip geldiği bir makale okudunuz mu? Bende var ve bunun fazlasıyla kafa karıştırıcı olduğunu söyleyebiliriz.

Yani, eğer birinci kişiyi kullanacaksanız – birini seçin ve bu konuda tutarlı olun. Yalnız olsanız bile, yine de “biz”i kullanmayı tercih edebilirsiniz. Sana bağlı! Sadece aynısını kullanın.

Ek olarak, birinci şahıs kullanmanıza bile gerek yok. “Ben” ve “biz” den tamamen kaçınmayı seçebilirsiniz.

Burada gerçekten doğru bir cevap yok - bu sadece tutarlılıkla ilgili.

Biçimlendirmenizi Standartlaştırın

Nihai bilgi bankası makale şablonu kılavuzumuzu okursanız, iyi bilgi tabanlarının küçük adımlarla çok sayıda talimat kullandığını bilirsiniz. Ve bu talimatlar, bir noktada, aşağıdaki gibi bir dil içerecektir:

Dosya üzerine tıklayın.

Yani – öyle mi:

• Dosyaya tıklayın
• "Dosya" yı tıklayın
• Dosyaya tıklayın

Ve gerçekten listelerinizi yazdığınızda, bu:

• Adım 1: Bunu tıklayın
• 2. Adım: Bunu tıklayın

Yoksa şöyle mi:

• Buna tıkla
• buna tıklayın

Yine – en sevdiğinizi seçebilirsiniz – ancak hangisini seçerseniz seçin, onu tüm bilgi tabanınızda tutarlı bir şekilde kullanın.

Yapmanız gereken başka biçimlendirme seçenekleri de var - Mozilla stil kılavuzu, ele almanız gereken her şey hakkında size iyi bir fikir verir, ancak işte bazı başlangıç ​​fikirleri:

• Başlık büyük harf kullanımı – cümle durumu mu yoksa Başlık Durumu mu kullanacaksınız?
• Sayılar – 10 mu, on mu?
• Kısaltmalar – yapma ya da yapma?
• Kısaltmalar – CDN veya içerik dağıtım ağı?

Bilgi tabanı WordPress temalarımızdan veya eklentilerimizden birini kullanıyorsanız, yerleşik kısa kodlarımız ve biçimlendirme seçeneklerimiz, biçimlendirme söz konusu olduğunda tutarlı kalmanıza yardımcı olabilir.

Sesi Doğru Alın

Son olarak, biçimlendirmenin ötesine geçmeniz ve sesinizi standartlaştırmanız gerekir.

Müşterinizin arkadaşı mısınız? Yoksa soğuk ve sert bilgeliği soğukkanlılıkla dağıtan Star Trek'ten Spock mısınız?

Mantık dahilinde, her ikisi de iyidir. Tutarlı olduğu sürece.

Genel olarak, MailChimp'in bilgi bankası kılavuz ipuçlarını takip ettiğinizden emin olmalısınız. Bunları yalnızca MailChimp kılavuzlarını yayınladığı için değil, aynı zamanda MailChimp'in oradaki en iyi bilgi tabanlarından birine sahip olduğunu düşündüğüm için öneriyorum.

Onların tavsiyesi şudur:

• Soruları cevaplamak ve okuyucularınızı bilgilendirmek için her zaman ilk önceliğiniz olsun. Şakalar bazen iyidir, ancak bu temel amaçtan dikkati dağıtmıyorsa.
• Bir pazarlamacı gibi konuşmaktan kaçının – sadece yardım etmeye çalışıyorsunuz.

Stil Rehberinizi Nerede Saklamalısınız?

Bu kararları sadece siz vermemelisiniz. Ayrıca aslında, bilirsiniz, onları güvenli bir yere yazmanız gerekir.

Şahsen, birlikte çalıştığım stil kılavuzlarının çoğu Google Dokümanlar belgeleridir. Bu şekilde stil kılavuzunuzu kolayca paylaşabilir ve farklı bilgisayarlardan erişebilirsiniz.

Ancak başka bir yöntemi tercih ederseniz, aşina olduğunuz yöntemle devam edin. Gerçekten önemli olan tek şey şudur:

Bilgi tabanı stil kılavuzunuzun bir kopyası, bilgi tabanınızı nasıl biçimlendireceğiniz konusunda bir tazelemeye ihtiyaç duyduğunuzda sizin veya başkalarının erişebileceği güvenli bir yerde depolanmıştır.

Öyleyse, kağıda dök ve daha tutarlı bilgi tabanı makaleleri oluşturmaya başla!