Ürün Belgeleri Nihai Kılavuz: Harika Belgeler Oluşturmak için Bilmeniz Gereken Her Şey

Ürün belgeleri… bir işletmeyi yönetmenin en seksi kısmı olmayabilir, ancak işinizin başarılı olmasını istiyorsanız göz ardı etmemeniz gereken önemli bir alandır.

Yüksek kaliteli ürün belgeleri oluşturmak, müşterilerinizi daha başarılı hale getirmenize, destek yükünüzü azaltmanıza ve genel olarak daha iyi bir iş kurmanıza yardımcı olabilir.

Ancak ürün dokümantasyonu oluşturmaya ne dahildir? Ve web sitenizde kendi belgelerinizi nasıl oluşturabilirsiniz?

Bunlar, ürün belgelerine yönelik nihai kılavuzumuzda yanıtlayacağımız sorulardan sadece birkaçı. İşte ele alacağımız her şey:

• Ürün dokümantasyon stratejinize neden önem vermelisiniz?
• Birinci sınıf dokümantasyonun bazı gerçek örnekleri
• En iyi ürün dokümantasyon yazılımı
• Daha iyi belgeler oluşturmak için sekiz ipucu

İşletmenizin belgeleri işleme biçimini geliştirmeye hazır mısınız? Hadi kazalım!

Ürün Belgelendirme Stratejinizi Neden Önemsiyorsunuz?

Ürün dokümantasyon stratejinizi neden gözden kaçırmamanız gerektiğine bir göz atarak başlayalım.

Müşterilerinizi Daha Başarılı Hale Getirir

Ürün dokümantasyonu oluşturmanın en büyük faydası, müşterilerinizi daha başarılı hale getirmesidir. Daha başarılı müşterilere sahip olmak, daha yüksek dönüşüm oranları, daha düşük kayıp oranları vb. anlamına gelir.

Mantıklı - eğer bir müşteri ürününüzden nasıl değer elde edeceğini çözemezse, çok uzun süre müşteri olarak kalmayacaklardır.

Ürün belgeleri, müşterileri mümkün olduğunca fazla değer elde etmeleri için eğitmenin yararlı bir yoludur. Ürününüzden daha fazla değer elde ettiklerinde, ödemeye devam etme, sizi arkadaşlarına/meslektaşlarına önerme vb. olasılıkları daha yüksek olacaktır.

Destek Yükünüzü Azaltır

Ürün belgeleri, insani destek kanallarınız üzerindeki yükü azaltmanın da harika bir yolu olabilir.

Ürün belgeleriniz düşük kaliteliyse veya mevcut değilse, bu, müşterilerinizin bir sorun olduğunda her zaman insan destek ekibinize ulaşması gerektiği anlamına gelir. Bu, destek taleplerine yanıt vermek için daha fazla zaman harcanması anlamına gelir.

Bu yanıtları kendiniz halletmek için işinizi büyütmeye zaman ayırmanız gerekecek ya da özel bir destek görevlisi tutmanız gerekecek ( bu da paraya mal olur).

Müşteriler, yüksek kaliteli belgelerle kendi sorunlarının çoğunu çözebilecek ve bu da desteğe ulaşma ihtiyacını ortadan kaldıracaktır. Ayrıca destek süreçlerinizi, insanları bir talepte bulunmadan önce belgelerinizi kontrol etmeye itecek şekilde yapılandırabilirsiniz.

İyi Bir Pazarlama ve Satış Aracı Olabilir

Pek çok insan ürün belgelerini satın almaya karar vermiş kişilere yardım bağlamında düşünürken, iyi ürün belgeleri de ilk etapta daha fazla müşteri çekmenize ve dönüştürmenize yardımcı olabilir.

Pazarlama açısından bakıldığında, ürün belgeleri, belgelerinizi sıralayabileceğiniz uzun kuyruklu SEO anahtar kelimelerinin altın madenidir. Doğrudan Google'ın ürün belgelerinize ulaşan kişi sayısı sizi şaşırtabilir. Belgelerinizi iyi yapılandırırsanız, bu insanları müşteriye dönüştürme şansınız olur.

Belgeleriniz, ürününüzü satın alma konusunda kararsız olan kişiler için de yararlı bir satış aracı olabilir. Ürün belgeleri, sahip olabilecekleri olası satış öncesi soruları ele alabilir, onları ürününüzün ihtiyaç duydukları şeyi yapabileceğine ikna edebilir ve ihtiyaç duyduklarında yardım alacaklarına dair güven verebilir.

Örneğin, Stripe en iyi ürün belgelerine sahip olmasıyla bilinir. Twitter'a giderseniz, Stripe'in belgelerinin kalitesi nedeniyle Stripe'i öneren birçok insan görebilirsiniz:

Çalışanlarınızı Daha Etkili Hale Getirir

Ürün dokümantasyonu sadece müşteriler için değil, aynı zamanda ekip üyelerinizin ürününüz hakkında bilgi edinmeleri ve gerektiğinde referans olmaları için önemli bir kaynak olabilir. Bu, özellikle ürününüz hakkında geniş bir bilgi tabanına sahip olmayan yeni çalışanlar için geçerlidir.

Dört Harika Gerçek Hayat Ürün Belgelendirme Örneği

Size biraz daha ilham vermek için, başarılı şirketlerden gerçek dünyadan bazı ürün belgeleri örneklerine bakalım.

1. şerit

Bir pazarlama/satış aracı olarak kaliteli belgelerin en iyi örneklerinden biri olarak Stripe'ten daha önce bahsetmiştik, bu nedenle Stripe belgelerinin listemizde bir numara olması gerektiğini biliyorsunuz.

2. Adyen

Adyen, e-ticaret, mobil ve satış noktası ödemeleri için bir ödeme platformudur. Stripe gibi, bu da geliştiricilerin onu mükemmel belgeler gerektiren kendi platformlarına entegre etmeleri gerektiği anlamına gelir. Adyen hayal kırıklığına uğratmaz – Adyen belgelerinin tamamına buradan göz atın.

3. Twilio

Twilio'ya aşina değilseniz, işletmelerin platformlarında metin mesajları, e-postalar, telefon görüşmeleri ve daha fazlasıyla iletişim kurmasına yardımcı olan bir araçtır. Stripe ve Adyen'de olduğu gibi bu, işletmelerin Twilio'yu birinci sınıf belgeler gerektiren mevcut hizmetlerine entegre etmeleri gerektiği anlamına gelir. Harika bir örnek görmek için Twilio belgelerine göz atabilirsiniz.

4. Gevşek

Slack, çok iyi yazılmış ve faydalı belgelere sahip başka bir araçtır. Slack belgelerinin tamamına buradan göz atabilirsiniz.

Daha fazla örnek görmek için, en iyi kullanıcı dokümantasyonu örnekleriyle ilgili yazımızın tamamına göz atın.

En İyi Ürün Dokümantasyon Yazılımı

Şimdi, sitenizde daha iyi ürün belgeleri sunmaya nasıl başlayabileceğinize bakalım.

Bir sonraki bölümde belgelerinizi gerçekten yazmaktan bahsedeceğiz. Ancak, belgelerinizi yazabilmeniz için önce bu makaleleri saklayacak ve kullanıcılarınız için erişilebilir hale getirecek bir yere ihtiyacınız var.

Bu makaleleri doğrudan sitenize ekleyebilirsiniz, ancak özel ürün dokümantasyon yazılımı kullanmak çok daha iyi bir fikirdir. İçeriğinizi düzenlemenin ve ziyaretçiler için erişilebilir kılmanın ötesinde, iyi ürün dokümantasyon yazılımı, aşağıdakiler gibi diğer faydalı özellikleri de içerecektir…

• Ajax arama işlevleri, ziyaretçilerin belgelere göz atmasına yardımcı olur.
• İnsanların hangi konuları aradığını görebilmek için analitiği arayın.
• Her bir makalenin ne kadar yararlı olduğunu takip edebilmeniz ve gerektiğinde iyileştirme yapabilmeniz için yararlılık verileri.

İşte en iyi çözümlerden ikisi…

Kahramanca Bilgi Tabanı (Kahramanca KB)

Heroic Knowledge Base, kendi kendine barındırılan ürün dokümantasyon merkezinizi kolayca oluşturmanıza olanak tanıyan ücretsiz, açık kaynaklı WordPress yazılımı için bir eklentidir.

İşletmenizin web sitesi için zaten WordPress kullanıyorsanız, kendi dokümantasyon merkezinizi oluşturmak için sitenize Kahraman Bilgi Bankası ekleyebilirsiniz. Veya yoksa, belgeleriniz için özel bir WordPress kurulumu oluşturabilirsiniz. İkinci durumda, KnowAll WordPress dokümantasyon teması da ilginizi çekebilir.

Heroic Knowledge Base, gerekirse multimedya içeriği eklemeyi kolaylaştıran WordPress içerik düzenleyicisini kullanarak tüm belgelerinizi eklemenize olanak tanır. Ayrıca, değişiklikleri kolayca izlemenize ve belgelerinizin önceki sürümlerini karşılaştırmanıza olanak tanıyan WordPress'in yerleşik içerik sürüm oluşturma sistemine de erişebilirsiniz.

Heroic Knowledge Base ayrıca aşağıdakiler de dahil olmak üzere bir dizi faydalı özellik ekler:

• Anında Ajax araması.
• Analitiği arayın.
• Makale yardımseverlik derecelendirmeleri.
• Makale dosyası ekleri.

Heroic Knowledge Base sadece 129$'a mal oluyor.

Adobe RoboYardım

Belgelerinizi yalnızca web'de yayınlıyorsanız, ihtiyacınız olan tek şey Heroic Knowledge Base gibi bir çözümdür. Ancak, daha kurumsal düzeyde belge gereksinimleri için belgelerinizi web, fiziksel kağıt, mobil uygulamalar, PDF'ler vb. dahil olmak üzere birden çok platformda yayınlamanız gereken durumlar olabilir.

Bu durumda, Adobe RoboHelp gibi çok platformlu bir belge geliştirme aracını tercih edebilirsiniz. Bireysel kullanım için aylık 29,99 dolardan başlayan fiyatlarla, Kahraman Bilgi Bankasından daha pahalıdır. Ancak, çok platformlu yazmaya ihtiyacınız varsa, bu ekstra fiyat verdiğiniz paraya değebilir.

Ürün Dokümantasyon Yapınızı ve İçeriğinizi Nasıl Optimize Edersiniz?

Artık belgelerinizi yönetmek için gereken yazılıma sahip olduğunuza göre, nasıl yüksek kaliteli makaleler yazabileceğinizden bahsedelim. Belgelerinizi yapılandırmak ve daha iyi yardım makaleleri yazmak için sekiz önemli ipucu…

1. Kitlenizi Anlayın

Harika ürün belgeleri yazmak için, yazdığınız hedef kitleyi (örneğin müşterileriniz) anlamanız gerekir.

Kimin için yazdığınız, hangi bilgileri eklediğinizi ve her şeyi nasıl yapılandırdığınızı etkiler. Örneğin, geliştiriciler için yazıyorsanız, belgeleriniz sıradan kullanıcılara yazmaktan kökten farklı olmalıdır.

Kitlenizin uzman olduğunu varsaymak ve önemli ayrıntılar üzerinde parıldamak istemezsiniz, ancak kim olduklarına bağlı olarak bazı temel bilgileri varsayabilirsiniz.

2. Farklı Ürün Belge Türlerini Anlayın

Farklı ürün dokümantasyon türleri vardır ve her biri farklı bir yaklaşım gerektirir. Yaygın türlerden bazıları şunlardır:

• Genel Bakış - bu makaleler, "Başlarken" kılavuzu gibi ürününüzün bir alanının nasıl çalıştığına dair bir genel bakış sağlar.
• Adım adım öğreticiler – bu makaleler, insanlara belirli bir görevi nasıl gerçekleştireceklerini gösterir.
• Referans – bu makaleler ürününüzdeki belirli kavramları açıklar.
• Sorun Giderme – bu makaleler, müşterilerin karşılaşabileceği yaygın sorunların nasıl hata ayıklanacağını/sorun giderileceğini açıklar.

Üzerinde çalıştığınız belge türü, nasıl yazdığınızı ve belgelerinizi nasıl yapılandırdığınızı etkilemelidir, bu nedenle, araştırmadan önce amacın ne olduğunu bilmek önemlidir.

3. Tarzınızda ve Adlandırma Kurallarınızda Tutarlı Olun

Ürün belgelerinizi müşterilerinizin kullanmasını kolaylaştırmak için, belgeleriniz boyunca aynı stili ve adlandırma kurallarını korumanız önemlidir. Bu, müşterilerin belgelerinizle birlikte takip etmelerini kolaylaştıracak ve olası karışıklıkları önleyecektir.

Bunu yapmanıza yardımcı olması için, temel biçimlendirme ve terminoloji için bir stil kılavuzu bulmanız yararlı olabilir.

4. Sade Bir Dil Kullanın ve Özlü Kalın

Her şey eşit, kısa, basit bir dil her zaman kelime salatasından daha iyidir. Amacınız, gerekli tüm bilgileri mümkün olduğunca az kelimeyle iletmek olmalıdır.

Ayrıca mümkün olduğunca jargon veya karmaşık terimler kullanmaktan kaçınmalısınız. Tüm müşterileriniz aynı bilgi tabanına sahip olmayacak ve bazıları belgelerinizin anadili bile olmayabilir, bu nedenle işleri olabildiğince basit tutmak herkesin belgelerinizden değer elde etmesini sağlar.

5. Belgeleri Mantıksal, “Sorun Boyutlu” Makalelerde Düzenleyin

İnsanların belgelerinize göz atmasını ve belirli sorunlarıyla ilgili makaleleri bulmasını kolaylaştırmak için belgelerinizi mantıksal bölümlere ayırmanız gerekir. Genel olarak, her makale belirli bir sorunu çözmeye odaklanmalıdır.

Tabii ki, bu ana problemin içinde birden fazla alt problem olabilir, ancak fikir şu ki, tamamen ayrı iki problemi aynı makaleye yığmak istemezsiniz çünkü bu, insanların bu konuları aramasını zorlaştıracaktır ve onlar makaleye geldiklerinde kafaları karışabilir.

Müşterileriniz belgelerinizi kitap okur gibi doğrusal bir şekilde okumayacaktır. Bunun yerine, o anda karşılaştıkları soruna göre atlayacaklardır. Makalelerinizi mantıksal bölümlere ayırmak, bu davranışı hesaba katmanıza yardımcı olur.

6. Multimedya Öğelerini Dahil Edin

Yazılı metin, ürün belgelerinizin özünü oluşturmalı, ancak tek şey bu olmamalıdır. Ayrıca, mantıklı olan yerlere resim ve video içeriği eklemek de yardımcı olabilir.

Ekran görüntüleri ekliyorsanız, önemli ayrıntıları netleştirmek için görüntülere açıklamalar da ekleyebilirsiniz.

7. Başlıkları Kullanın ve İçindekiler Tablosu Ekleyin

Bireysel ürün dokümantasyon makalelerinde, makalelerinizi yalnızca uzun bir metin duvarı yazmak yerine mantıksal bölümlere ayırmak için başlıklar kullandığınızdan emin olun.

İnsanların makalede gezinmesine yardımcı olmak için, okuyucuların belirli bir bölüme hızla atlamasını sağlayan bir içindekiler tablosu da ekleyebilirsiniz.

Bazı ürün belgeleme yazılımları, otomatik olarak içindekiler tablosu eklemenize yardımcı olabilir. Örneğin, Heroic Knowledge Base eklentisi, her makalenin başlığına göre otomatik olarak bir içindekiler tablosu oluşturmak için yerleşik bir özellikle birlikte gelir.

8. Belgelerinizi Daima İyileştirin ve Güncelleyin

Son olarak, ürün belgeleri oluşturmanın tek seferlik bir olay olmadığını hatırlamak önemlidir; devam eden bir süreçtir.

Temel düzeyde, ürününüz büyük olasılıkla değişikliklere uğrayacaktır, bu nedenle bu değişiklikleri ve eklediğiniz yeni özellikleri hesaba katmak için belgelerinizi güncellemeniz önemlidir.

Ancak bunun ötesinde, Heroic Knowledge Base gibi ürün dokümantasyon yazılımını seçerseniz, insanların dokümanlarınızı nasıl kullandığını anlamanıza yardımcı olacak analizlere erişim elde edeceksiniz. Bu analizleri şu amaçlarla kullanabilirsiniz:

1. İnsanların ne aradığını takip edin; bu, henüz yapmadıysanız, bu konularla ilgili belgeler oluşturmanız gerektiğinin bir işareti olabilir.
2. Hangi makalelerin kullanıcılara istediğiniz kadar yardımcı olmadığını görün; bu, onların yararlılığını artırmak için bu makalelerde iyileştirmeler yapmanız gerektiğinin bir işareti olabilir.

Harika Ürün Belgeleri Oluşturmaya Bugün Başlayın!

Yüksek kaliteli ürün belgeleri oluşturmak, işletmenizin uzun vadeli başarısına yapılan bir yatırımdır. Size yardımcı olur…

• Müşterilerinizi daha başarılı hale getirin.
• Destek ekibinizin yükünü azaltın.
• İlk etapta daha fazla müşteri çekin ve dönüştürün.
• Çalışanlarınızın ürününüz hakkındaki bilgilerini geliştirin.

Bu gönderide, başarılı şirketlerden bazı harika ürün belgeleri örneklerini ve belgelerinizi nasıl yazacağınız ve yapılandıracağınızla ilgili bazı ipuçlarını paylaştık.

Kendi ürün dokümantasyon merkezinizi oluşturmaya hazırsanız, WordPress tarafından desteklenen kendi kendine barındırılan çözümünüzü oluşturmak için Heroic Knowledge Base eklentisini kullanabilirsiniz. Kahramanca Bilgi Tabanı hakkında daha fazla bilgi edinmek için tıklayın.