12 En İyi Dokümantasyon Örneği

Müşterileriniz ürün veya hizmetlerinizle ilgili sorunlarına kendi başlarına çözüm bulabiliyor mu? Ve bunu hızlı ve kolay bir şekilde yapabiliyorlar mı?

Bu soruların her ikisine de evet yanıtı vermek, harika bir müşteri deneyimi sağlamanın ve müşteri memnuniyet oranınızı artırmanın büyük bir parçasıdır. Bu nedenle, müşterilerinizin personelinizden birinin yanıt vermesini beklemeden sorularına yanıt bulmalarına yardımcı olacak belgelere sahip olmak çok önemlidir.

Ancak, çevrimiçi belgelerinizi sıfırdan yazmak hiç de fena bir başarı değil. Sizden önce başarılı bir şekilde yapmış markalara bir göz atmanızda fayda var. Bu yazıda, farklı belge kategorilerini ve bu kategorilerdeki en iyi belge örneklerini keşfedeceğiz. Ayrıca, oradaki en iyi belgelerin yolunu nasıl takip edebileceğinizi ve kendi belgelerinizi nasıl oluşturabileceğinizi göreceğiz. Başlayalım.

Belge Türleri

Belge örneklerine geçmeden önce, farklı belge türleri hakkında bilgi edinmek önemlidir. Bu, işletmeniz için en anlamlı olan türleri anlamanıza yardımcı olacaktır.

Kullanıcı Belgeleri

Kullanıcı dokümantasyonu, bir ürün veya hizmetin son kullanıcılarına tam potansiyelini kullanmak için ihtiyaç duydukları yardımı sağlamak için kullanım kılavuzlarının, hızlı başlangıç ​​kılavuzlarının, öğreticilerin, SSS'lerin ve diğer eğitim materyallerinin oluşturulmasıdır.

Geliştirici Belgeleri

Tahmin edebileceğiniz gibi, geliştirici belgeleri, geliştiricilerin belirli bir yazılım kitaplığını veya hizmetini, tipik olarak API'si (uygulama programlama arabirimi) aracılığıyla nasıl kullanabileceklerini veya entegre edebileceklerini tüm yönleriyle anlamaları içindir. Geliştirici belgeleri, kullanım senaryoları, kimlik doğrulama, sorun giderme bilgileri vb. gibi materyalleri içerir. Genellikle müşteriye yönelik kullanıcı belgelerinden daha teknik yazılardan oluşacaktır.

Teknik döküman

Teknik belgeler, kullanıcı belgeleri ile geliştirici belgelerinin ortasında bir yerde bulunur ve genellikle teknik bir yazara ihtiyaç duyar. Bir ürünle ilgili teknik talimatları veya kavramları, geliştirici olmayanların bile anlayabileceği şekilde anlaşılır bir şekilde açıklamayı amaçlar.

Proje belgeleri

Proje dokümantasyonu, bir projeyle ilgili önemli detayların kapsanmasını içerir. Bu, projeyi düzgün bir şekilde yürütmek için gerekli olanı açıklamak için kapsamlı belgeler oluşturmakla ilgilidir. Proje dokümantasyonunun bazı örnekleri arasında proje teklifleri, proje planları, iş vakaları, durum raporları vb. yer alır.

Dokümantasyonun Faydaları

Anladık. İşinizi yürütmekle meşgulsünüz ve isteyeceğiniz son şey, durum raporları, kılavuzlar vb. gibi şeyleri sürekli olarak belgelemek zorunda kalmaktır. Bununla birlikte, beklenmedik sorunlar birdenbire ortaya çıktığında (ki ortaya çıkacaktır), sizin ve kullanıcılarınızın geri dönülmesi gereken belgelere sahip olduğunuzdan memnun olacaksınız. Yeterli belgelere öncelik vermenin temel avantajları şunlardır.

Tek Bir Yerde Bilgi

Ortalama bir bilgi çalışanının günde yaklaşık 2,5 saatini bilgi aramak için harcadığı tahmin edilmektedir. Etkili dokümantasyon, tüm gerekli bilgileri tek bir yerde toplayarak herkese önemli miktarda zaman kazandırır.

Verimliliği Artırın

Belgeler, bir ekip üyesinin yokluğu veya bilinen bir sorunun yeniden ortaya çıkması gibi beklenmedik olaylarda bile işlerin yapılmasını sağlar. Kimlik bilgilerini, ayrıntıları ve daha fazlasını takip ederek kaynakları boşa harcamadan tekerlekleri hareket ettirebilirsiniz.

Memnuniyeti Artırın

Belgeler, müşterilerinizin mutlu ve memnun kalmasına yardımcı olur. Belgeler, ürününüzden en fazla değeri nasıl elde edeceklerini göstererek, müşteri kayıp oranını azaltır ve müşteri yaşam boyu değerinizi artırır.

Avantajları ortadan kaldırarak, dört belge türünün her biri için en iyi belge örneklerine geçelim.

Kahramanca Bilgi Bankası Eklentisi

Bir bilgi tabanı oluşturun ve müşterilerinizin kendilerine yardım etmesine yardımcı olun.

Eklentiyi Alın

Kullanıcı Belgelendirme Örnekleri

Google

Google'ın tanıtıma ihtiyacı yok. Her ürünün kendi dokümantasyonuna sahip olduğu yüzlerce ürün sunar. Google'ın ürün belgelerinin öne çıkan özelliği, kullanıcıların geri bildirim göndermeleri ve soru sormaları için statik yanıtların ve topluluk forumlarının bir kombinasyonu olmasıdır.

Google'ın belgelerinin diğer dikkate değer özellikleri şunları içerir:

• Kullanıcılar, olağandışı sorgularda birbirlerine yardımcı olabilir. Bu, müşterilere kendilerini daha iyi duyurmak ve endişelerini dile getirmek için daha iyi bir şans verir.
• Olumlu Oy özelliği, diğer insanların da aynı sorunlarla karşılaşıp karşılaşmadığını görmek ve en önemli sorunlar ve fikirler için destek toplamak için harikadır.
• Müşteriler ayrıca bir tartışmadaki güncellemelere abone olabilir veya ek bir bakış açısına katkıda bulunmak için yorum gönderebilir.

Skype

Skype, iş toplantıları, eğitim oturumları ve kişisel sohbetler gibi farklı amaçlar için kullanılan, Microsoft'un popüler bir görüntülü toplantı yazılımıdır. Skype, yazılım belgeleri farklı gezinme ve sıralama seçenekleri gibi kullanıcı dostu özelliklerle yüklendiğinden harika bir belge örneği oluşturur.

Dikkat edilmesi gereken diğer şeyler şunlardır:

• Kullanıcılar, yardımcı olacak bir belge bulup bulmadıklarını belirtebilir ve geri bildirimlerini paylaşabilir.
• Ekmek kırıntıları ve içindekiler tablosu gibi özellikler, belgelerde gezinmeyi kolaylaştırır.

Apple iPhone

Apple'ın iPhone'u, sezgiselliği ve kullanıcı dostu özellikleriyle bilinir, ancak bu, uygun belgeleri göz ardı etmek için bir mazeret değildir. Neyse ki, Apple bunu anlıyor ve belgeleri iPhone kadar basit ve gezinmesi kolay.

iPhone belgelerinin dikkate değer yönleri şunları içerir:

• Bir kullanıcının şu anda yüklediği iOS sürümünü seçme seçeneği vardır. Bu, son kullanıcıların talimatların doğru ve kendileriyle alakalı olduğundan emin olmasına yardımcı olur.
• Diğer özelliklere ve cihaza özel ekran görüntülerine atıfta bulunmak için bir içindekiler tablosu kullanılmıştır.
• Bir belge sorgularını yanıtlamazsa, kullanıcılar doğrudan destek ekibiyle iletişime geçebilir.

Geliştirici Belgeleri Örnekleri

Docker Belgeleri

Docker, uygulamaları oluşturmak, çalıştırmak ve göndermek için açık bir platformdur. Yazılımları hızlı bir şekilde teslim etmek için uygulamaları altyapıdan ayırmanıza olanak tanır. Docker'ın belgelerine harika bir başlangıç ​​sağlayan şey, Gece Modu ile Gündüz Modu arasında geçiş yapabilme yeteneğidir.

Bu belgeleri harika yapan diğer faktörler şunlardır:

• Çeşitli bölümlerin sonunda Recap ve Cheat Sheet bölümleri bulunmaktadır. Bu bölümler, bir kullanıcının gözden kaçırmış olabileceği kavramları güçlendirmeye yardımcı olur.
• Bir kullanıcının bir bilgiyi genişletmesini kolaylaştırmak için belgelerin tüm sayfalarında dahili bağlantılar sağlanır.
• Geçerli sayfada sağlanan içgörüleri anlamak için gerekli olan bir ön koşul sayfasına veya bölüme geri dönmeyi sağlar.

Heroku Geliştirme Merkezi

Heroku, geliştiriciler için güçlü ve kolay bir uygulama dağıtım hizmeti sunar. Ve geliştirici merkezinin güzel bir dokümantasyon kurulumu var. Bu belgenin en önemli özelliği, farklı bir dile geçmenin ne kadar kolay olduğudur.

İşte Heroku belgeleri hakkında kayda değer bazı şeyler.

• Farklı programlama dilleri için ilgili paketleriyle birlikte sıralı adımlar verir.
• Github'u kod deposu olarak kullanmak gibi, Heroku ile birlikte sıklıkla kullanılan diğer araçlar ve entegrasyonlar hakkında kaynaklar mevcuttur.

Twilio Dokümanlar

Twilio, 2008'den beri işletmelere ve geliştiricilere özelleştirilmiş iletişim çözümleriyle yardımcı olan en iyi API sağlayıcısıdır. Twilio'nun geliştirici belgeleri, hemen bilmeniz gereken her şeyi veren şık iki panelli tasarıma sahip bir sanat eseridir. Sol panel basit açıklamalar sunarken, sağ panel kullanışlı kod parçacıkları sağlar.

Bu dokümantasyonu harika yapan başka ne var? Devamındaki:

• Twilio'nun geliştirici belgeleri, zarif bir yazı tipi stiline ve zıt köprülere sahiptir. Tüm arayüz gözler için çok kolay.
• Geliştiricilerin zamandan ve zahmetten tasarruf etmek için hemen kopyalayıp yapıştırabilecekleri birkaç kaynak kod parçacığı vardır.
• Twilio, "Her neyse, REST API nedir?" gibi konularla yeni başlayanlar için bile inanılmaz bir derinlik düzeyi sağlar.

Teknik Dokümantasyon Örnekleri

Kampanya İzleme

E-posta pazarlama aracı Campaign Monitor, iyi yapılmış teknik belgelerin harika bir örneğidir. Arama özelliğine odaklanır, ardından müşterilere yardımcı olmak için temiz, düzgün yapılandırılmış bir makale koleksiyonu izler.

Onu iyi dokümantasyon yapan başka ne var?

• Makaleler, e-posta otomasyon yazılımlarının özelliklerine uyan kategorilere ayrılmıştır.
• Uygulama Durumu göstergesi, müşterilere karşılaştıkları sorunun Kampanya İzleme'nin sonundan olup olmadığını söyleyerek stresi azaltan akıllıca bir harekettir.

canva

Canva, kişisel ve profesyonel kullanım için iOS ve Android cihazlarda da kullanılabilen grafik tasarım araçları sunar. Canva'nın tasarımdaki uzmanlığı, kendi güzel dokümantasyon sayfalarından bellidir. Arama işlevinden makale kategorilerine kadar, kullanıcıların doğru çözümü hızla bulması için net seçenekler vardır.

Canva'nın belgeleri şu nedenle işe yarar:

• Ana sayfa, en iyi makalelerin, kategorilerin ve diğer destek seçeneklerinin harika bir karışımına sahiptir.
• "Popüler Aramalar", müşterilerin arama özelliğini etkili bir şekilde kullanmak için arayabilecekleri ifade türlerini anlamalarına yardımcı olur.

Dropbox

Bir bulut depolama hizmeti kullanıyorsanız, Dropbox'ı duymuş olmalısınız. Dropbox gibi bir SaaS çözümü için, en yaygın sorunları doğrudan ana sayfada çözmek akıllıca bir karardır.

Dropbox belgelerinin öne çıkan ek özellikleri şunlardır:

• Çekici illüstrasyonların kullanımı, markasının insanları sorunlarıyla rahatlatmada uzun bir yol kat eden dostane havasını pekiştiriyor.
• Dropbox topluluğuyla entegrasyon, kullanıcılar arasındaki etkileşimleri kolaylaştırır ve yardım aramak için ek bir yol sağlar.

Proje Dokümantasyon Örnekleri

Guelph Üniversitesi Proje Tüzüğü

Proje başlatma belgesi, her bir paydaşın rol ve sorumluluklarına ek olarak projenin kapsamı, hedefleri ve gelişimi ile ilgili ayrıntıları paylaşan resmi bir proje yetki belgesidir.

Guelph Üniversitesi'nin proje başlatma belgesi harika bir belgeleme örneğidir. Kolay anlaşılır bir tablo düzeninde bir proje başlatma belgesi için gerekli olan tüm hususları kapsar.

MS Word için Proje Planı Şablonu

Proje belgelerine başka bir örnek, MS Word için basit bir proje planı şablonu. Görevler eklemenize, başlangıç ​​ve bitiş tarihlerini takip etmenize ve her bir görevin durumunu izlemenize olanak tanır.

Proje Durum Raporu

Proje durum raporu, projenin mevcut durumunu tüm paydaşlara iletmek için proje yöneticisi tarafından hazırlanan haftalık bir rapordur. Temel düzeyde, kapsamı, bütçeyi, programı, sorunları ve riskleri kapsar. İşte bir örnek.

Web Sitenize Belge Ekleme

Belgeleri yazmak ve sürdürmek göz korkutucu gelebilir. Ancak yazdığınız her belge, on binlerce müşterinizin insan yardımına ihtiyaç duymadan sorularına yanıt bulmasına yardımcı olabilir.

Başlamaya hazırsanız, web sitenize belgeler eklemek için Heroic KB'yi düşünün. Harika görünen belgeleri WordPress sitenizle bütünleştiren, kullanımı kolay bir bilgi tabanı eklentisidir. Heroic KB'nin ana özellikleri şunları içerir:

Anında Tema Entegrasyonu : Şablon merkezli bir yapıya sahip olan Heroic Knowledge Base, belgelerinizin görünümünü ve hissini kontrol etmenizi sağlar. Ayrıca, Heroic KB'yi WordPress için en esnek bilgi tabanı eklentilerinden biri yapan tema entegrasyon notları da sağlanır.

Anında Yanıtlar : Yıldırım hızında AJAX araması, müşterilerin ihtiyaç duydukları şeyi saniyeler içinde bulmasını sağlar.

Yerleşik Analitik : Bilgi tabanınızın kullanıcılarınıza ne kadar iyi yardımcı olduğuna dair içgörüler edinin. Ayrıca, kullanıcılarınıza yardımcı olanları tam olarak belirlemek için makaleler hakkında geri bildirim toplayabilirsiniz.

Kolay Organizasyon : Heroic KB, her şeyi istediğiniz gibi sipariş edebilmeniz için sürükle ve bırak kategori sıralamasıyla birlikte gelir.

Kullanıcı Erişim Kontrolü : Parola ile koruyun ve makaleleri farklı kullanıcı rollerinden gizleyin.

Dosya Ekleri Desteği : Makalelerinizde ziyaretçilerinize indirilebilir dosyalar sağlayın.

Widget Desteği : Sitenizde bilgi bankası makalelerini, kategorileri ve yazarları görüntülemek için üç widget vardır.

Geliştirici Dostu : Heroic KB, varsayılan olarak duyarlı stilin yanı sıra iyi kodlanmış temaların çoğuyla kutudan çıktığı gibi çalışır.

Dil Desteği : Eklenti, WPML uyumluluğu ile çeviriye hazırdır ve eksiksiz yerelleştirme desteği sunar.

Mükemmel Müşteri Hizmeti : Heroic KB ekibi, herhangi bir sorunla karşılaşmanız durumunda her zaman yardımcı olmaya istekli ve hızlıdır.

Bir WordPress kullanıcısı olarak, elbette, makaleleri blog gönderileri olarak ekleyebilirsiniz. Ancak belirli bir KB eklentisi kullanmanın bir takım avantajları vardır. Belgelerinizi yönetmeyi ve kullanıcılarınızın belgeleri diğer içeriğinizden ayrı olarak aramasını çok daha kolaylaştırır.

Diğer seçenek, özel bir bilgi bankası teması kullanmaktır, ancak bu, yalnızca web sitenizin tamamı bilgi tabanınızsa iyi bir fikirdir. Mevcut bir WordPress web sitesine bir bilgi tabanı eklerken, bir eklenti açık ara en iyi çözümdür.

Yukarıdaki örneklerden de görebileceğiniz gibi, harika dokümantasyon sadece mevcut müşterileri memnun etmek için değil, aynı zamanda personeli eğitmek ve potansiyel müşterileri çekmek için de muazzam bir potansiyele sahiptir. Web sitenize belge eklemek için harcadığınız çabalar, önümüzdeki yıllarda cömertçe karşılığını verecektir. Öyleyse bugün Heroic KB'yi kullanmaya başlayın.