Organize!Bilgi Stili Kılavuzu Nasıl Yapılır

Bir bilgi tabanı yazmak oldukça zordur. Bu yazıda ne yapacağım için özür dilerim. Size bunun sadece bilgi tabanınızdaki fikirler değil, aynı zamanda nasıl sunduğunuzla ilgili olduğunu söyleyeceğim. Bakın, bu fikrin ötesinde, her zaman olduğunuzdan emin olmalısınız:
Doğru tonu kullanın
Her şeyi sürekli olarak aynı şekilde biçimlendirin
Yang, bir sonraki bölümde açıklayacağım nedenlerden dolayı aslında çok zor. Bilgi stili kılavuzu bir rol oynar. Bilgi tabanınız neden muhtemelen farklı bir stille uğraşır, eğer bilgi tabanınız farklı stillerin bir karışımı ise çok fazla endişelenmeyin. Birçok şirkete, genellikle iki nedenden biri (veya bazen her ikisi!) Nedeniyle olur.
İlk olarak, ekibin bir parçasıysanız, destek belgeleri yazan farklı kişileriniz olabilir. Öyleyse:
Jim bir makale yazdı
Sally bir makale yazdı
Önceden belirlenmiş bir kuvvet kılavuzunuz yoksa bu makaleler çok farklı bir stile ve formata sahip olabilir. Şimdi, bir takımın parçası değilseniz, “Ben bir kurtum – her şeyi kendiniz yazıyorum. Bu yüzden kağıda hiçbir şey yazmam gerekmiyor – hepsi benim! ” Ve bu olabilir … tüm bilgi tabanı makalelerinizi bir oturuşta yazarsanız.
Ama ikimiz de bunun olağan çalışma yolu olmadığını biliyoruz, değil mi? Ürününüzü ilk piyasaya sürdüğünüzde birçok bilgi tabanı makalesi yazabilirsiniz. Ama sonra, üç ay sonra yeni bir özellik yayınladınız. Şimdi yeni özellikler için bir bilgi tabanı girişi yazmalısınız ve … insan hafızası o kadar iyi değil. Denemeseniz bile, nihayet farklı bir şey yapmanız muhtemeldir. Yani, ister solo ister ekibin bir parçası olun, bilgi taban stili kılavuzunuzu kağıda koymak iyidir. Şirket bunu gerçekten yapıyor mu? Bilgi stili rehberi gerçek bir şey mi? Tamam, size yakında stil rehberinizi nasıl yapacağınızı söyleyeceğim. Ama önce, bunu gerçekten yapan birkaç şirket örneğiyle liderlik etmek istiyorum. Bu iki hedefe ulaşıyor: Bu, sadece daha fazla blog içeriği yapmak için bunu yapmadığımı gösteriyor
Bu size kendi stil rehberiniz için çizebileceğiniz gerçek bir hayat örneği sunar.
Önce Mozilla’ya bakalım. Mozilla, bilgi tabanları için stil kılavuzunda tüm girişlere sahiptir. Mozilla açık bir kaynak olduğundan, kendi sözleriyle bir stil rehberine sahip olmaları çok önemlidir, “Firefox desteği bir bilgi tabanı yapmak tutarlıdır, okunması ve katkıda bulunması kolay bir bilgi tabanı üretir.” Okuması kolay? Bilgi tabanınız için iyi bir hedef gibi geliyor, değil mi?
Bu kılavuz derinlemesine, başkent, beyaz alanlardan seri komaya kadar her şeyi getiriyor. Ayrıca, Voice & Ton Mailchimp bir başka değerli okumadır. % 100 bilgi tabanına odaklanmasa da, bilgi ve öğretici içerik tabanı için bir dizi girişe sahip olsa da: Mozilla tarzı kılavuz stil ve biçimlendirmeye daha fazla odaklanmış olsa da, MailChimp daha fazla, iyi, ses ve tona odaklanmayı seçti. INS ve çıkışları biçimlendirmek yerine. Bilgi tabanınız için bir stil kılavuzu nasıl yapılır size bazı örnekler veriyorum, ancak size gerçekten kendi bilgi stili kılavuzunuzu yapmak için bir süreç vermedim. Öyleyse düzeltelim!