Docsie Teams'in favori dokümantasyon örneklerini ve bu örnekleri bilgi portalınızda nasıl çoğaltabileceğinizi görün
Dokümantasyon, ürün geliştirme sürecinin ayrılmaz bir parçasıdır. Ürün bir kavram kanıtından gerçeğe dönüşürken, açıklayıcı dokümantasyon, müşterileri ürününüzü nasıl kullanacakları konusunda eğitmek için gereklidir.
Bir müşterinin bir ürünü seçerken bilmesi gereken ilk şeyler nelerdir? Ne işe yarar, ne işe yarar ve nasıl yaparım? Örnek olarak Docsie'yi kullanalım!
Docsie bir ürün dokümantasyon platformudur. Kullanıcıların çevrimiçi bir bilgi portalında dokümantasyon oluşturmasına, düzenlemesine, açıklama eklemesine ve yayınlamasına olanak tanır. Giriş yapmak, yeni bir Docsie Kitabı oluşturmak ve ilk içerik parçanızı yazmak kadar basit!
Kuşkusuz, bunu basit tuttuk. Ancak ürün dokümantasyonu için, karmaşık özellikler ve işlevler, konsepti eve götürmek için daha kapsamlı açıklamalar gerektirir.
Bu makalede, Docsie ekiplerinin en sevdiği 10 harika ürün dokümantasyonu örneğini inceleyeceğiz. Daha da iyisi mi? Ayrıca size kendi harika ürün dokümantasyonunuzu nasıl yapacağınızı da göstereceğiz (harika örneklerimizden ilham alarak!)
Hadi içeri dalalım! 🤿
10 Şaşırtıcı Ürün Dokümantasyon Örneği
Aşağıda, Docsie ekibi tarafından seçilen 10 harika ürün dokümantasyonu örneği bulacaksınız. Özellikleri ve işlevleri nasıl çoğaltabileceğinizi ve Docsie'de kendi harika dokümantasyonunuzu nasıl oluşturabileceğinizi keşfedeceğiz!
1 - Docker
Docker, küçük, modüler ve ayrı ayrı izole edilmiş BT ortamlarında yazılım barındırmayı sağlayan bir konteyner sanallaştırma platformudur. Konsept, işletim sistemi kaynaklarını konteynerler arasında bölerek ve paylaştırarak birden fazla farklı hizmetin tek bir ana bilgisayar işletim sisteminde barındırılmasına olanak tanır.
Docker, net bir şekilde biçimlendirilmiş bir ürün dokümantasyon portalına sahiptir ve Docker konteynerlerini indirmek, kurmak ve kullanmaya başlamak için gereken tüm temel bilgileri sunar. Ayrıca çok dilli ürün belgeleri, API referans belgeleri ve alt kısımda sıkça sorulan sorular (SSS) bölümü paylaşıyor. Görsel öğrenenler için sağ altta bir video bölümü de var.
Bir Başlangıç bölümü oluşturmak için örnek olarak Docsie'yi kullanalım. Docsie'de başlamak için bir hesap oluşturmalı, e-posta adresinizi onaylamalı, Docsie Workspace kontrol panelini yüklemeli, yeni bir Raf oluşturmalı, yeni bir Kitap oluşturmalısınız - temel bilgiler bu kadar! Her bölüm için bir başlık çerçevesi oluşturun, talimatlar yazın, resimler ve köprüler ekleyin ve sonuçta aşağıdakine benzer bir yapı elde edeceksiniz!
En iyi kısmı mı? Docsie bunu sizin için otomatik olarak yapıyor!
Docsie'de bunun nasıl yapıldığını görmek için Docsie Hızlı Başlangıç kılavuzunu okuyun!
2 - Şerit
Stripe, Stripe komut satırı arayüzünü (CLI) kullanarak özel entegrasyonlara ve ödeme parametrelerine olanak tanıyan teknik işlevselliğe sahip uluslararası bir ödeme işleme platformudur. Misyonu, e-ticareti kolaylaştıran sanal ekonomik altyapı oluşturarak internetin GSYİH'sini artırmaktır.
Bu Stripe sayfası teknik ürün dokümantasyonu olarak bilinir. Docker konteynerleri (tekrar merhaba!) oluşturmak ve terminal komutlarından başka bir şey kullanmadan Stripe ile iletişim kurmak için bir CLI'nin nasıl kullanılacağını araştırıyor. Sayfada bir İçindekiler Tablosu, kopyala-yapıştır işlevine sahip kod blokları ve metin içi köprüler göreceksiniz.
Docsie kod bloklarına sahiptir, bu yüzden bunları nasıl kullanacağımızı keşfedelim
Docsie'deki bu Kod Blokları Örneğine göz atın
Örneğimizi takip etmek için bu kodu kopyalayın -
console.log('Merhaba Dünya');
Docsie Editöründe bir Docsie Kitabı açın. Aşağıdaki GIF, araç çubuğunda Kod Bloğu seçeneğinin nasıl bulunacağını gösterir ve "Merhaba Dünya!" yazdıran bir JavaScript örneği içerir.
Docsie Portalınızda, teknik okuyucular için netliği artırmak için kod vurgulama uygulanır. Kullanıcılar kullanışlı pano simgesiyle kodu bile kopyalayabilir!
Docsie'de Code Highlighting eklentisinin nasıl uygulanacağını görün!
3 - Apple
Her yerde bulunan elma! Hayır, yenilebilir türden değil!
Apple, popüler akıllı telefon serisi iPhone için mükemmel ürün belgeleri sunuyor. Apple ürün belgeleri örneğimizde bir sürüm seçici, içindekiler tablosu, metin ve başlıklar ve son olarak satır içi görüntüler bulunmaktadır.
Docsie'de sürüm kontrolünü keşfedelim!
Docsie bilgi portalındaki belgeleri okurken, okuyucular sürüm seçici eklentisini kullanarak bir sürüm seçebilir.
Bu, okuyucuların geçmiş ürün belgelerini görüntülemesine olanak tanır - bilirsiniz, henüz güncellenmemiş olan arkadaki yavaş dürtmeler için!
Docsie'de yeni bir sürüm oluşturmak için Docsie Editör'deki sürüm yönetimi sekmesini kullanın.
Buradan Sürüm ekle + seçeneğine tıklayın.
Ardından, Sürüm ekle düğmesine tıklamadan önce bir sürüm numarası ve sürüm adı seçin. İşte bu kadar kolay! Yeni sürüm belgesini tüm özellik değişiklikleriyle güncelleyin ve müşterilerinizin en son (veya geç) bilgileri bulmasını sağlayın!
4 - Ayrıştırma
Parse, uygulama arka uçları için açık kaynaklı çerçeveler sağlayan mükemmel bir tam yığın yazılım platformudur. Basitçe, geliştiricilerin herhangi bir geliştirme projesine entegre ederken güvenebilecekleri önceden hazırlanmış kod kaynakları sunar.
Parse dokümantasyon portalında, uyumluluk tabloları şeklinde harika bir dokümantasyon örneği bulunmaktadır. Bu, Node.js ve MongoDB gibi farklı mimarilerin Parse platformuyla uyumluluğunu izler.
Bunu Docsie'de yapalım!
Docsie'deki tablo bloklarını kullanarak Parse örneğine benzer dört sütunlu bir tablo oluşturabiliriz.
Tablo bloğu simgesini ve ardından dört sütun seçeneğini seçin.
Yazarken, sütunlar boyunca ilerlemek için Enter tuşunu kullanın. Metni kalın yapmak için klavyede Ctrl + B tuşlarını kullanın. Son olarak, sembol seçeneğini kullanarak emojiler ekleyin.
Bu, API belgeleri ve teknik yazılım belgeleri yazmanın kolay bir yoludur. Node.js web sitesine köprüler veya ilgili kullanıcı kılavuzlarına dahili bağlantılar ekleyerek daha da ileri gidebilirsiniz. Bir sonraki API uyumluluk tablonuzu Docsie'de sunun!
5 - Çırpınış
Flutter, mobil, web, masaüstü ve gömülü cihazlarda kullanıcı arayüzü tasarımında tutarlılığı sağlamak için Google tarafından oluşturulan bir UI araç setidir. Çevrimiçi bir kod editörü ile hızlı kullanıcı arayüzü tasarımını ve geliştirmeyi teşvik eder ve katmanlı konteyner tabanlı bir mimari tam özelleştirmeye izin verir.
Flutter, kullanıcıların izlemesi ve platform hakkında bilgi edinmesi için bir dizi video barındırıyor. Platform Google tarafından yapıldığından, YouTube örneğimiz için mantıklı bir seçimdir!
Bu tasarımı Docsie'de video gömme bloklarını kullanarak taklit edebilirsiniz!
Docsie Book'unuza tıklamanız, video yerleştirme simgesini seçmeniz ve ardından YouTube URL'sini metin alanına kopyalamanız yeterlidir. Aynı işlemi Dailymotion, Vimeo ve diğer bir dizi video barındırma web sitesi için de yapabilirsiniz.
Docsie'ye kendi videolarınızı ekleyebilmeniz için bu süreci gösteren bir GIF'imiz var - bir deneyin!
6 - İyonik Çerçeve
Ionic Framework, HTML, CSS, JavaScript ve diğer web teknolojilerini kullanarak performanslı masaüstü ve mobil uygulamalar oluşturmak için açık kaynaklı bir UI araç setidir.
Çeşitli UI bileşenleri, yerel cihaz işlevleri ve tema desteği ile Angular, React ve Vue gibi popüler çerçevelerle entegre olur.
Ionic'in sitesinde gömülü harika bir cep telefonu örneği var. Benzer bir örneği iFrame yerleştirmelerini kullanarak Docsie Book'umuza ekleyelim!
İlk olarak, aşağıdaki kodu kopyalayın:
<iframe loading="lazy" importance="low" src="https://ionic-docs-demo.herokuapp.com/?ionic:mode=ios"></iframe>
Ardından, Docsie Düzenleyici'deki kod yerleştirme bloğuna tıklayın. iFrame gömme kodunu buraya yapıştırın, ardından devam etmek için Kaydet'e tıklayın. Aşağıda bu işlemi gösteren bir GIF var.
Docsie'de iFrame kullanan resmi entegrasyon listemize bakın!
7 - DigitalOcean
DigitalOcean, müşterilerin sunucuları, sanal makineleri, veritabanlarını ve daha fazlasını barındırmasını sağlayan bir bulut bilişim hizmetleri platformudur. Ölçeklenebilir konteyner uygulamaları için özel Kubernetes hizmetleri ve web barındırma, mobil uygulamalar, büyük veri gölleri ve VPN hizmetleri için yönetilen çözümler sunar.
DigitalOcean, kullanıcı geri bildirimlerini toplamak ve içeriği yinelemek için dokümanlarında geri bildirim işlevi sunar. Bunu Docsie'de nasıl yapacağımızı keşfedelim!
Vocally, Docsie'de geri bildirim toplamak için eşdeğer bir özelliktir. Kullanıcıların bir yıldız derecelendirmesi, metin geri bildirimi ve hatta bir video kaydı bırakmasına olanak tanır - tatlı!
Burada, gönderilen tüm Docsie Vocally geri bildirimlerine erişebilirsiniz. Kullanıcılar 1-5 yıldız arası bir derecelendirme ve kısa bir metin açıklaması seçeneğine sahiptir. Bazı kullanıcılar, sorunu tam olarak belirlemenize yardımcı olacak bir ekran kaydı bırakmak isteyebilir!
Her Docsie müşterisi Vocally'ye erişebilir ve belgelerinizdeki güçlü ve zayıf yönleri ortaya çıkarma konusunda paha biçilmezdir. Her zaman ilk seferde doğru yapamazsınız, ancak yazarlarınız Docsie Vocally'yi kullandığında bir sonraki yinelemede daha doğru yapabilirsiniz!
8 - Gevşeklik
Slack tartışmasız bir şekilde iş dünyasının Whatsapp'ı haline geldi. Popüler iş anlık mesajlaşma (IM) platformu, iş iletişimlerini düzenlemek ve basitleştirmek için sesli ve görüntülü aramalar, resim ve GIF paylaşımı, yorum yanıt ağaçları ve daha fazlasını sunuyor.
Slack, önemli bilgileri vurgulamak ve ilgili özellikleri belirtmek için dokümantasyon portalı boyunca araç ipuçları sunar. Bunu Docsie'de tekrarlayalım!
Docsie'de alıntı bloklarını kullanarak yukarıdaki gibi bir araç ipucu oluşturabiliriz.
Çeşitli Docsie Editor düğmelerinin nasıl kullanılacağını öğrenin.
Docsie Editor araç çubuğuna gidin ve alıntı bloğu simgesini seçin. Burada bilgi, uyarı veya soru bloğu türlerini seçebilirsiniz. Bunu aşağıdaki animasyonlu GIF'te gösteriyoruz.
İşte canlı bir Docsie Portalında bilgi, uyarı ve soru alıntı bloklarını kullanan bazı varyasyonlar. Soru-cevap ifadeleri oluşturmak için soru ve uyarı bloklarını da kullanabilirsiniz - bir sonraki Docsie Kitabınızda alıntı bloklarını kullanarak yaratıcılığınızı konuşturun!
9 - Pas
Rust, hız düşünülerek tasarlanmış bir programlama dilidir. Segfaultları önleyebilir ve işlemci thread güvenliğini garanti eder. Rust, REST-API çerçeveleri oluşturmak, PostgreSQL gibi veritabanı çözümleriyle iletişim kurmak ve çok daha fazlası için kullanılabilir.
Rust Standart kütüphanesi, API belgelerine göz atmayı basitleştirmek için çalışan satır içi kod parçacıkları içerir. Docsie'de eşleştirelim!
Satır içi kod parçacıkları Vec<T> ve Option<T> içerir. Bunu Docsie'de işaretleme düğmesini kullanarak yapabiliriz.
Metni kod olarak işaretlemek için, metni vurgulamak üzere tıklayıp sürüklemeniz ve ardından işaretleme düğmesine tıklamanız yeterlidir. Aşağıda bu işlemi gösteren bir GIF bulunmaktadır.
İşaretleme metni ayrıca köprüler içerir. Bu bağlantı, kod parçacığının ne işe yaradığını açıklayan bir terimler sözlüğüne yönlendirmelidir.
Docsie'de nasıl köprü oluşturulacağına dair hızlandırılmış bir kurs alın.
10 - Yoast
Yoast, işletmelerin WordPress sitelerini optimize etmelerine ve en iyi SEO uygulamaları hakkındaki bilgilerini geliştirmelerine yardımcı olmak için tasarlanmış bir arama motoru optimizasyonu (SEO) platformudur. Yoast SEO eklentisi, müşteri etkileşimini artırmak için web sitelerini Google arama motoru sonuç sayfalarında (SERPS) daha iyi performans için optimize eder.
Yoast, dokümantasyon portalında liste başlıklarını kullanarak adım adım kılavuzlar sunar. Bunu Docsie'deki liste başlıkları ile kopyalayabiliriz!
Bunu Docsie'de yapmak için önce bir Kitap oluşturun ve Docsie Editörünü açın.
Ardından, metin alanına tıklayın ve Docsie Editor araç çubuğundaki liste başlığı seçeneğini seçin. Aşağıda bu işlemi gösteren bir GIF var.
Liste başlıkları HTML spesifikasyonunun bir parçasıdır. Docsie'de liste başlıkları, belgeleriniz içinde doğrudan bağlantılar oluşturmanıza izin verdiği için harikadır. Bu, kullanıcılar bir bağlantıya tıkladığında, doğrudan liste başlığına yönlendirilecekleri anlamına gelir (kaydırmak veya kaydırmak zorunda kalmak yerine!)
Bu Docsie Özelliklerini Avantajınıza Kullanın! 🏆
Bu 10 dokümantasyon örneği, kullanıcı kılavuzlarının ne kadar faydalı olabileceğini gösteriyor. Bir dahaki sefere bir kullanıcı kılavuzu oluşturduğunuzda, bu Docsie ipuçlarını ve püf noktalarını kendi yararınıza kullanın! Bizim seçtiğimiz örnekler harika, ancak sizinkilerin daha da iyi olacağını biliyoruz! 📐👌
Docsie, işletmelerin web tabanlı SSS'ler, ürün dokümanları, kullanıcı kılavuzları, yardım dokümanları ve kullanıcı kılavuzları oluşturmak için kullandıkları uçtan uca bir dokümantasyon yönetim platformudur. Platform, müşteri odaklı işbirliği, kapsamlı yerleştirme, özel çeviriler ve parmaklarınızın ucunda güçlü yayıncılık özellikleri sunar.
Bugün Start onboarding ve Docsie ile keyifli dijital belgeler sunun!