Ürün Belgeleri Ana Kılavuzu: Harika belgeler yapmak için bilmeniz gereken tek şey
Ürün belgeleri … belki bir iş yürütmenin en seksi kısmı değil, ancak işinizin başarılı olmasını istiyorsanız görmezden gelmemeniz gereken ana alandır. Yüksek kaliteli ürün belgeleri yapmak, müşterilerinizi daha başarılı hale getirmenize, desteğinizin yükünü azaltmanıza ve genellikle daha iyi bir iş kurmanıza yardımcı olabilir. Peki ürün belgeleri yapmak ne oluyor? Ve web sitenizdeki kendi belgelerinizi nasıl yönetebilirsiniz? Bu, ürün belgeleri için ana kılavuzumuzda cevaplayacağımız birkaç soru. Tartışacağımız her şey bu:
Ürün belge stratejinizi neden önemsemeniz gerekiyor?
En iyi belgelerin bazı somut örnekleri
En İyi Ürün Dokümantasyon Yazılımı
Daha iyi belgeler yapmak için sekiz ipucu
İşletmenizin belgeleri işleme şeklini geliştirmeye hazır mısınız? Hadi kazalım! Neden ürün belgelendirme stratejinizi önemsemeniz gerekiyor, neden ürün dokümantasyon stratejinizden tasarruf etmenize gerek olmadığına bakalım. Bu, müşterilerinizi daha başarılı hale getirir, ürün belgeleri yapmanın en büyük yararı, müşterilerinizi daha başarılı kılmaktır. Daha başarılı müşterilere sahip olmak, daha yüksek bir dönüşüm seviyesi, daha düşük bir karmaşa seviyesi vb.
Bu mantıklı – eğer müşteriler ürününüzden değer elde etmenin yollarını bulamazlarsa, uzun süre müşteri olarak kalmazlar. Ürün belgeleri, müşterileri eğitmenin yararlı yollarından biridir, böylece mümkün olduğunca çok değer elde edebilirler. Ürününüzden daha fazla değer elde ettiklerinde, büyük olasılıkla ödeme yapmaya devam edecek, sizi arkadaşlarına/iş arkadaşlarına tavsiye edecekler, vb. Bu, ürün belgeleri için desteğinizin yükünü azaltır, insan destek kanalınızın yükünü azaltmak için iyi bir yol olabilir. Ürün belgeleriniz düşük kalitedeyse veya yoksa, müşterinizin insan destek ekibinizle iletişime geçmesi gerektiği anlamına gelir. Her zaman bir sorun var. Bu, destek taleplerine yanıt olarak harcanan daha fazla zaman anlamına gelir. Bu yanıtı ele almak için işinizi geliştirmek için zaman ayırmalısınız veya adanmış (paraya ihtiyaç duyan) kişileri işe almanız gerekir. Yüksek kaliteli belgelerle, müşteriler desteğe ulaşma ihtiyaçlarını ortadan kaldıran kendi sorunlarının çoğunu çözebileceklerdir. Ayrıca, bir istek göndermeden önce insanları belgelerinizi kontrol etmeye teşvik etmek için bir destek süreci de ayarlayabilirsiniz.
Bu iyi bir pazarlama ve satış aracı olabilirken, birçok kişi satın alma işlemi yapmaya karar veren insanlara yardımcı olma bağlamında ürün belgelerini düşünürken, iyi ürün belgeleri daha fazla müşteriyi çekmenize ve dönüştürmenize yardımcı olabilir. Pazarlama perspektifinden bakıldığında, ürün belgeleri, belgeleriniz için geliştirebileceğiniz uzun bir SEO SEO anahtar kelimesidir. Ürün belgelerinizi Google’dan hemen gören kişi sayısından şaşırabilirsiniz. Belgelerinizi iyi derlerseniz, bu kişileri müşterilere dönüştürme fırsatınız olacak. Belgeleriniz, ürününüzü satın almakta tereddüt eden insanlar için de yararlı bir satış aracı olabilir. Ürün belgeleri, sahip olabilecekleri ön satma potansiyel sorularını cevaplayabilir, ürününüzün ihtiyaç duyduklarını yapabileceğine ikna edebilir ve ihtiyaç duyduklarında yardım alacaklarına dair güven verebilir. Örneğin, Stripe’in en iyi ürün belgelerinden bazılarına sahip olduğu bilinmektedir. Twitter’ı açarsanız, Stripe belgelerinin kalitesi nedeniyle birçok kişinin Stripe’i önerdiğini görebilirsiniz:
Bu, çalışanlarınızı sadece müşteriler için değil, aynı zamanda ekip üyelerinizin ürünlerinizi ve referanslarınızı gerektiğinde öğrenmesi için önemli bir kaynak olabilir. Bu, özellikle ürününüz hakkında geniş bir bilgiye sahip olmayan yeni çalışanlar için geçerlidir.
Size daha fazla ilham vermek için harika olan gerçek yaşam ürünlerinin dört dokümanı örneği, başarılı şirketlerden gerçek dünya ürünlerinin bazı dokümantasyonlarına bakalım. 1. Çizgi, bir pazarlama/satış aracı olarak kaliteli belgelerin en iyi örneklerinden biri olarak önceki şeritten bahsediyor, bu nedenle şerit belgelerinin listemizde bir numara olması gerektiğini biliyorsunuz. 2. Adien
3. Twilio Twilio’ya aşina değilseniz, bu, işletmelerin kısa mesajlar, e -postalar, telefon görüşmeleri ve daha fazlası aracılığıyla platformlarında iletişim kurmasına yardımcı olan bir araçtır. Stripe ve Adyen gibi, bu da işletmelerin Twilio’yu en iyi belgeleri gerektiren mevcut hizmetlerine entegre etmeleri gerektiği anlamına gelir. İyi bir örnek görmek için Twilio belgesine göz atabilirsiniz. 4. gevşek Slack, çok iyi ve kullanışlı yazılmış belgelere sahip başka bir araçtır. Tüm gevşek belgeleri burada izleyebilirsiniz. Diğer birkaç örneği görmek için, en iyi kullanıcı belgeleri örnekleri hakkındaki yayınımıza bakın.
Şimdi en iyi ürün belge yazılımı, sitenizde daha iyi ürün belgeleri sunmaya nasıl başlayabileceğinize geçelim. Bir sonraki bölümde belgelerinizi yazma hakkında konuşacağız. Ancak, belge yazmadan önce, makaleyi kaydetmek ve kullanıcılarınız için erişilebilir hale getirmek için bir yere ihtiyacınız vardır. Bu makaleyi doğrudan sitenize ekleyebilmenize rağmen, özel ürün belge yazılımı kullanmanız daha iyi olur. İçeriğinizi ayarlamanın ve ziyaretçiler tarafından erişilebilir hale getirmenin yanı sıra, iyi ürün belgeleri yazılımı, ziyaretçilerin dokümantasyonları izlemesine yardımcı olmak için Ajax arama işlevi gibi diğer yararlı özellikleri içerecektir. Arama analizi, böylece insanların aradığı konuyu görebilirsiniz. Her bir makalenin nasıl yardımcı olduğunu ve gerekirse nasıl arttığını izleyebilmeniz için verileri kullanın.
İşte en iyi iki çözüm … Kahraman Bilgi Üssü (Kahraman KB)
Kahraman Bilgi Base, kendi ürün dokümantasyon merkezinizi kolayca oluşturmanızı sağlayan ücretsiz açık kaynaklı WordPress yazılımı için bir eklentidir. WordPress’i işletme web siteniz için kullandıysanız, kendi belge merkezinizi oluşturmak için sitenize kahramanca bilgi tabanı ekleyebilirsiniz. Veya değilse, belgeleriniz için özel bir WordPress kurulumu oluşturabilirsiniz. Son durumda, WordPress Knowall belgelerinin temasıyla da ilgilenebilirsiniz.
Kahraman bilgi tabanı, tüm belgelerinizi WordPress içerik düzenleyicisini kullanarak eklemenize olanak tanır, bu da gerekirse multimedya içeriğine girmenizi kolaylaştırır.Ayrıca, değişiklikleri kolayca izlemenizi ve belgelerinizin önceki sürümünü karşılaştırmanıza olanak tanıyan WordPress içerik oluşturma sisteminin varsayılan sürümüne de erişebilirsiniz.Kahraman Bilgi Üssü, Instant Ajax Arama da dahil olmak üzere bir dizi yararlı özellik de ekledi.
Arama analizi.
Makale Yardım Sıralaması. Ek Makale Dosyası.
Kahraman bilgi tabanı sadece 129 dolar değerinde.Adobe Robo Yardımı
Belgelerinizi yalnızca Web’de yayınlarsanız, yalnızca ihtiyacınız olan kahraman bilgi tabanı gibi çözümler. Bununla birlikte, daha fazla şirket seviyesi belge ihtiyacı için, belgelerinizi Web, fiziksel kağıt, hücresel uygulamalar, PDF’ler vb. Bu durumda, Adobe Robohelp gibi çok platformlu belge yapımcıları tercih edebilirsiniz. Bireysel kullanım için ayda 29,99 dolardan başlayarak, bu kahramanca bilgi tabanından daha pahalıdır. Ancak, çok platform yapımına ihtiyacınız varsa, ek fiyat parayla orantılı olabilir. Ürün belgelerinizin yapısını ve içeriğini nasıl optimize edersiniz, belgelerinizi yönetmek için gereken yazılımdan sonra, yüksek kaliteli makaleler nasıl yazabileceğiniz hakkında konuşalım. Dokümantasyonunuzu derlemek ve daha iyi yardım makaleleri yazmak için sekiz temel ipucu … 1. Kitlenizi harika ürün belgeleri yazmak için anlayın, yazdığınız kitleyi (yani müşterinizi) anlamanız gerekir. Kim için yazdığınız bilgileri dahil ettiğinizi ve her şeyi nasıl düzenlediğinizi etkileyecektir. Örneğin, bir geliştirici için yazarsanız, belgeleriniz sıradan kullanıcılar için yazmaktan çok farklı olmalıdır. Kitlenizin uzmanını düşünmek ve ana ayrıntıları görmezden gelmek istemezsiniz, ancak bazı temel bilgilerin kim olduklarına bağlı olduğunu varsayabilirsiniz. 2. Çeşitli ürün belgelerini anlayın Çeşitli ürün belgeleri türleri vardır ve her biri farklı bir yaklaşım gerektirir. Bazı yaygın türler:
Genel Bakış-Bu makale, ürününüzün “başlangıç” kılavuzu gibi alanının nasıl genel bir resim sunar.
Referanslar – Bu makale ürününüzdeki belirli kavramları açıklamaktadır.
Problem Çözme-Bu makale, müşteriler tarafından karşılaşabilecek ortak sorunların nasıl hata ayıklayacağını/çözüleceğini açıklar.
Üzerinde çalıştığınız dokümantasyon türü, yazma şeklinizi ve belgelerinizi nasıl düzenlediğinizi etkilemelidir, bu nedenle daha derine inmeden önce amacın ne olduğunu bilmek önemlidir. 3. Adlandırma tarzınızda ve ürün belgelerinizin müşterileriniz tarafından kullanımı kolaylaştırılması için tutarlı olarak, tüm belgelerinizde aynı adlandırma stilini ve konvansiyonunu korumanız önemlidir. Bu, müşterilerin belgelerinizi takip etmesini ve karışıklık olasılığından kaçınmasını kolaylaştıracaktır. Bunu yapmanıza yardımcı olmak için, biçimlendirme ve temel terminoloji için bir stil kılavuzu oluşturmak yararlı olabilir. 4. Düz dili kullanın ve her şeyi aynı, kısa, basit dil her zaman salata kelimesinden daha iyidir. Amacınız, kelimelerde gereken tüm bilgileri mümkün olduğunca az iletmektir. Mümkünse karmaşık bir jargon veya terim kullanmaktan da kaçınmalısınız. Tüm müşterileriniz aynı bilgi tabanına sahip olmayacak ve bazıları belge dilinizin orijinal konuşmacısı bile olmayabilir, bu nedenle olabildiğince basit tutmak, herkesin belgelerinizin değerini alabilmesini sağlayın. 5. İnsanların belgelerinizi izlemelerini ve özel sorunları için makaleler bulmasını kolaylaştırmak için mantıklı olan “Sorunların Büyüklüğü” makalesindeki belgeleri ayarlayın, belgelerinizi mantıksal bir segmente ayırmanız gerekir. Genel olarak, her makale belirli bir sorunu çözmeye odaklanmalıdır.
Temel düzeyde, ürününüz değişiklikler yaşayabilir, bu nedenle eklediğiniz değişiklikleri ve yeni özellikleri dikkate almak için belgelerinizi güncellemeniz önemlidir. Ancak bunun ötesinde, kahramanca bilgi tabanı gibi ürün dokümantasyon yazılımlarını seçerseniz, insanların belgelerinizi nasıl kullandıklarını anlamanıza yardımcı olmak için analitik erişim elde edersiniz. Bu analitik şu adreste kullanabilirsiniz: insanların ne aradığını izleyin, bu da yapmadıysanız konu hakkında belge yapmanız gereken bir işaret olabilir.
Hangi makalelerin istediğiniz kadar kullanıcıya yardımcı olmadığını görün, bu da kullanımlarını artırmak için makalede iyileştirmeler yapmanız gerektiğine dair bir işaret olabilir.
Şimdi olağanüstü ürün belgeleri yapmaya başlayın! Yüksek kaliteli ürün belgeleri yapmak, işletmenizin uzun vadeli başarısına bir yatırımdır. Bu size yardımcı olur …
Müşterilerinizi daha başarılı hale getirin.
Destek ekibinizin yükünü azaltın.
İlginç ve ilk etapta daha fazla müşteri dönüştürmek.
Çalışanlarınızın ürününüz hakkındaki bilgilerini artırın.
Bu yazıda, başarılı şirketlerin ürün belgelerinin bazı iyi örneklerini, belgelerinizi nasıl yazacağınıza ve derleyeceğine dair bazı ipuçları ile birlikte paylaşıyoruz. Kendi ürün belge merkezinizi yapmaya hazırsanız, WordPress tarafından güçlendirilen kendi yayınlanan çözümlerinizi oluşturmak için Kahraman Bilgi Taban eklentisini kullanabilirsiniz. Kahraman bilgi tabanı hakkında daha fazla bilgi edinmek için tıklayın.
