Çok sayıda teknoloji SaaS şirketi, ürün belgelerini (kullanım kılavuzları, kullanıcı kılavuzları ve/veya öğreticiler) geliştirme ve tüketicilerine dağıtma sürecinde zorlanmaktadır.
Bu durum genellikle kılavuzların uygun şekilde ele alınması ve üretilmesi, hatta bunlardan kimin sorumlu olduğu konusunda bilgi veya süreç eksikliğinin bir sonucu olarak ortaya çıkar.
Bu dünyada araçlara ve yazılımlara ihtiyaç duyulduğu sürece, bu ürünlerin kullanımını, geliştirilmesini, işleyişini ve mimarisini başkalarına etkili bir şekilde aktarmak için etkili iletişime ihtiyaç duyacağız. Bunun nedenini merak ediyorsanız, cevabı basit. Çünkü teknik iletişim becerileri, bilgi toplamak ve izleyicilerin ürünü veya teknolojiyi daha etkili bir şekilde anlamasını sağlamak için çok önemlidir.
Gerçek dünyada iletişim konuşma, beden dili ve duygu ifadeleri ile yapılırken, sanal dünyada teknik iletişim teknik ürün dokümantasyonu ile gerçekleşir!
Teknik ürün dokümantasyonunun tek amacı, kullanıcının bir ürünün ve teknolojinin çalışma dinamiklerini ve mimarisini anlamasını kolaylaştırmaktır. Bu daha çok yeni çalışanlarınız, kullanıcılarınız/müşterileriniz ve çalışma yöntemlerinden haberdar olması gereken herkes için bir "nasıl kullanılır" el kitabı, bir ürünün somun ve cıvatalarının kapsamlı bir açıklaması gibidir!
Ürün yöneticilerinin görevi, parlak ürün dokümantasyonunu oluşturmak, yönetmek, yayınlamak ve sürdürmek için bir ekip geliştirme sorumluluğunu üstlenmektir.
Eminim her ürün yöneticisi kendi departmanında aşağıdakileri söylemiştir ya da duymuştur: "Ürün dokümantasyonu, Ürün Sahibinin yükümlülüklerinin bir bileşenidir"; "Her geliştirme ekibi kendi uygulamalarını dokümante etmelidir"; "özellik dağıtıldı, kılavuz güncellendi mi?" veya daha da kötüsü, "teknik dokümantasyonda bir hata var".
Açıkçası, teknik ürün dokümantasyonu göründüğü kadar basit olsa da biraz kafa karıştırıcı olabilir! Bireyler bir önceki paragraftaki satırları çözmeye veya tartışmaya çalışırken, kılavuzlar ve öğreticiler bozulur ve bu da "ürün/şirket" imajınıza zarar verir.
Benzer sorunları yaşayan herkese yardımcı olmak amacıyla, ürün belgelerinizi optimize etmek için uygulayabileceğiniz bazı prosedürleri burada bulabilirsiniz.
Ürün dokümantasyonunun amacı nedir?
Teknolojik bir ürün veya hizmet için ürün dokümantasyonundan bahsederken, onu tanımlayan bilgilerden ve ona ait verilerden bahsediyorsunuz demektir.
Teknik dokümantasyon veya ürün dokümantasyonu, hedef kitlenizin ve müşterilerinizin ürününüzü kullanmasına, okumasına, anlamasına ve yararlanmasına yardımcı olmakla ilgilidir. Elbette çoğu ürün dokümantasyonu mühendislik, tıp, bilgi teknolojileri ve pazarlama gibi çeşitli alanlarda üretilir.
Mükemmel teknik ürün belgeleri, hedef kitlenizin ürününüzde gezinmesine yardımcı olur ve ürününüzü sorunsuz bir şekilde kullanmalarını sağlar.
Bir diğer husus ise teknik dokümantasyonun müşteri desteği için kritik öneme sahip olması ve şirketinizin markasına ve güvenine önemli ölçüde katkıda bulunmasıdır. Kullanıcılar en çok ihtiyaç duydukları anda teknik dokümantasyonu ararlar. Kitle, süreçler hakkında bilgi edinmek ve sorunlarla başa çıkmak için ürününüzü kullanır.
Bu, arama özellikleriyle dinamik olan kapsamlı ve kapsamlı ürün belgelerine sahip olmanın çok önemli olduğu anlamına gelir
Farklı ürün belgeleri nelerdir
Bu bölüm, müşterileriniz veya müşterileriniz için ne tür ürün belgelerine ihtiyacınız olduğunu görmenizi sağlar.
Farklı kullanım durumları ve kullanıcı ihtiyaçlarını karşılayan birçok farklı ürün dokümantasyonu türü vardır:
Ürün Kullanıcı belgeleri: Kullanıcı kılavuzları, nasıl yapılır kılavuzları, öğreticiler, SSS'ler, sürüm notları ve eğitim kılavuzlarının yanı sıra işletim prosedürlerinden oluşur.
Kurumsal dokümantasyon: Anketler gösteriyor ki, ankete katılan 1000 şirketten 10'undan 8'inden fazlası resmi politikalar ve prosedür kılavuzları kullanıyor.
Yukarıdaki araştırmada belirtildiği gibi şirket politikaları ve prosedürlerine atıfta bulunan belgeler, kullanım kılavuzları, teknik uygulamalar, davranışsal ve etik belgelerden oluşan başka birçok kurumsal belge vardır. Parola korumalı olabilecek yasal belgelerin yanı sıra. Ayrıca şirket yapıları, en iyi uygulamalar ve prosedürlerin yanı sıra bakım kılavuzları
Geliştirici Dokümantasyonu: bu tür dokümantasyon, yazılım ürünü geliştirme, işlevsel özellikler, teknik özellikler, dokümantasyon ve geliştirici iş akışına yardımcı olacak araçlar için talimatlar sağlar.
Artık farklı teknik ve ürün dokümantasyonu türlerini daha iyi anladığımıza göre, ürün dokümantasyonu geliştirme sürecinin sağlam bir yönetiminin ilk adımlarının nelerle başladığını tartışalım.
Ürün dokümantasyonu geliştirme müdürü bulun
Çok tipik bir sorun, ürün dokümantasyonundan kimin sorumlu olması gerektiğinin belirlenmesidir; sadece güncelleyen biri olarak değil, ürünün kalitesi ve başarısından sorumlu biri olarak.
Bazı işletmeler her bir ürün sahibinin ve/veya ürün müdürünün ürün dokümantasyonundan sorumlu olduğuna inanırken, geliştirme ve destek dokümanları gibi diğer departmanlara da kullanıcı kılavuzlarını, kullanıcı rehberlerini ve ürün dokümantasyonunun tüm yönlerini güncel ve etkili tutma sorumluluğu verilebilir.
Ürün dokümantasyonunun geliştirilmesinin birçok hareketli parçası vardır, ancak burada bunlardan ikisine işaret edeceğiz:
-
Ürünün her seviyede nasıl çalıştığını anlayanlar (buna ürün geliştirme ve spesifikasyon ekipleri de dahildir).
-
Ürün dokümantasyonunu gözden geçiren müşterilerden girdi alan ve eldeki ürün dokümantasyonunu anlama konusundaki zorluklarını, geri bildirimlerini ve endişelerini dinleyenler.
İlk bölüm, elimizdeki bilgilerle tahsis edilen ürün dokümantasyonunu oluşturmamıza yardımcı olur ve bu, karşılığında geri bildirim veren ve dokümantasyonu optimize etmeye yardımcı olan ikinci süreçleri başlatan müşteriye gönderilir.
Bazen bu iki nokta mükemmel bir şekilde yerine oturmaz ve bu da ürün dokümantasyonunun asla gerekli ilgiyi görmediği durumlara yol açar.
Bir yaklaşım, ürün belgeleri, ürün kılavuzları ve kullanıcı kılavuzlarının "performansından" sorumlu olacak bir kişi belirlemektir. Ürünü "Ürün Dokümantasyonu" olan bir satın alma siparişi düşünün. Bu kişi, şirketin tüm ekiplerini gözden geçirerek her bir Ürünün kılavuzlarını nasıl oluşturduğunun taslağını çıkarmaktan ve bu süreçle ilgili zorlukları belirlemekten sorumludur.
Amaç, bu ürün sahibi ve ürün yöneticisinin kılavuzların oluşturulması ve değiştirilmesinden tamamen sorumlu olması değil, her ekipteki bireylere belge yönetimi konusunda yardımcı olmaktır.
Bu kişi, kullanıcıların belgelerle nasıl etkileşime girdiğini incelemeli, güncellemeleri daha akıcı hale getirmenin yollarını sunmalı ve her ürün belgesinin ve açıklayıcıların hedef kitlesiyle nasıl geliştirileceğini belirlemek için geri bildirim toplamalıdır.
Ürün dokümantasyonunun tüm yönlerinden sorumlu, iş akışını ve bu dokümantasyonu tamamlaması gereken farklı departmanları yöneten birinin olması, şirket içinde verimliliği artıracak, farkındalık yaratacak ve müşterileri ürün hakkında bilgi portalları ile eğitecek ve sonuçta ürün anlayışını kolaylaştıracaktır.
Ürün belgelerinize ürünün kendisi olarak bakın.
Ürünler, müşterinin beklentilerini karşılayan veya aşan bir değer sunmak için vardır. D2WorldWide tarafından oluşturulan istatistiklere göre](https://www.d2worldwide.com/product-documentation-why-do-customers-still-want-it-and-retailers-still-need-it/) insanların %73,7'si satın almayı düşündükleri ürünler hakkında bilgi ararken dokümantasyonu videolardan, ambalajlardan veya satış görevlilerinden daha yararlı bulmaktadır.
Bir ürünün çekiciliğine katkıda bulunan faktörleri göz önünde bulundurun. Bir ürünün çekiciliğini etkileyebilecek çeşitli faktörler vardır, ancak bu makalenin iyiliği için üç tanesine odaklanacağız. Değer açısından beklentileri aşarlar; kullanımları memnuniyet yaratır; ve rekabetçidirler.
Ayrıca, aynı kavramlar iyi bir çevrimiçi ürün dokümantasyonu için de geçerlidir. "Beklenen değerin ötesine geçen" ürün belgeleri sadece belirtilen ürünün nasıl kullanılacağını göstermekle kalmaz, aynı zamanda müşterinin farkında olmadığı veya mümkün olmadığını düşündüğü çözümler de sunar. Başarılarından ve hatalarından ders çıkarmak için diğer şirketlerin ürün dokümantasyonlarını nasıl başlattıklarını görmek her zaman gereklidir.
Teknik ürün belgelerinizi entegre eden geliştiriciler ve müşteriler bunları kavrayamıyorsa, rekabette önde olan benzersiz ve yüksek kaliteli yazılımlar geliştiren bir şirkete sahip olmanın hiçbir anlamı yoktur.
Ürün belgelerini okuyan kişinin ürün tarafından sunulan olası çözümler yelpazesine veya pazara aşina olmayabileceğini (teknik SaaS ürünlerinde genellikle olduğu gibi) ve bu nedenle bu çözümler ve ürünle ilgili çeşitli seçenekler hakkında "eğitilmesi" gerektiğini düşünün.
"Kullanılabilirliği memnuniyet yaratan" ürün belgeleri, hedef kitlelerine uygun mantıksal bir okuma modelini takip eder. Eğer 500 sayfalık bir PDF ise veya bir Kod örneği içermiyorsa ve arama yetenekleri ve diğer işlevlerle dinamik olarak oluşturulmamışsa, dünyadaki en kapsamlı kılavuza sahip olmanın bir faydası yoktur. Ürün belgenizin kullanıcılarından ve destek personelinizden geri bildirim toplayın. Raporlanan verilerle bağlantılı başlıca stres alanlarını tespit edeceklerdir.
Rekabetçi ürün belgeleri, en etkili bilgi alışverişi teknikleri kullanılarak sürekli güncellenen belgelerdir. Yerleşik arama yetenekleri, çeviriler, farklı sürümler, gömülü resimler, videolar ve çok daha fazlası gibi harika özelliklere sahiptirler!
Entegrasyon kılavuzunuz tüm teknoloji işletmeleri arasında en iyi şekilde yazılmış olsa bile, teknik SaaS ürünlerinizi satın alan teknoloji meraklısı müşterileriniz için kullanım kolaylığı sağlamak üzere kopyalanıp yapıştırılabilecek görseller ve kodlar ile ek bir video olmadan cazibesini yitirecektir.
Başarılarından ve hatalarından ders çıkarmak için diğer firmaların evraklarını nasıl başlattıklarını görmek her zaman gereklidir.
Belgelerinizi entegre eden geliştiriciler ve müşteriler bunları bütünüyle kavrayamıyorsa, rekabette önde olan benzersiz ve yüksek kaliteli yazılımlar geliştiren bir şirkete sahip olmanın bir anlamı yoktur.
Ürün Dokümantasyonu geri bildirimi
Etkili teknik ürün dokümantasyonu, ürünleri anlama ve hazır yazılı çözümlerle sorunları teşhis etme sürecini iyileştirerek son kullanıcı deneyimini geliştirir. Müşteriler ürünlerinize güvendiklerinde ve nasıl kullanacaklarını anladıklarında, gelecekte ihtiyaç olduğunda size geri dönebilirler.
SDL tarafından yapılan yeni bir araştırma, dokümantasyonun dünya çapındaki pazarlarda oynadığı rolün giderek arttığını ortaya koyuyor. Araştırma, alıcıların yaklaşık %53'ünün ürünü denemeden önce teknik literatürü kullanarak satın alma yaptığını göstermektedir. Ayrıca, bu araştırmadan derlenen bir başka istatistik, alıcıların %94'ünün ürün bilgilerinin tek bir yerde bulunmasının yararlı ve faydalı olduğunu düşündüğünü göstermektedir. Bu nedenle, her şirket bugünlerde ürün geliştirme veya test etmenin yanı sıra ürün dokümantasyonuna da eşit derecede önem veriyor.
Dokümantasyonun, dokümantasyon ekibini yöneten atanmış bir sahibi olsa bile, bu kişi revize edilmiş, daha iyi kullanılabilirlik için değerlendirilmiş ve uygun şekilde güncellenmiş ürün dokümantasyonu oluşturmuş olsa bile, kullanıcılarınızın ve tüketicilerinizin teknik ürünlerinizi anlamasını sağlamakta zorlanmaya devam edersiniz. Bu durum, kullanıcıların/okuyucuların belgelerinizi nasıl okuduklarını veya gerçekten sordukları soruları anlayamamalarının bir sonucu olarak ortaya çıkabilir. Bu da belge kompozisyonunun en zorlayıcı yönlerinden birinin kendini okuyucunun yerine koymak olduğunu gösteriyor. Sonuçta, ürün dokümantasyonunu üreten her kimse, ürün hakkında sağlam bir anlayışa sahip olmalıdır.
Bu uzmanlık, yazarın ortalama bir kullanıcı için çok açık olmayan şeyleri gözden kaçırmasına neden olabilir. Tipik olarak bu durum, ürünü yaratan kişiler için apaçık olan bir şeyin, ürünü satın alan ve kullanan kişiler için tam olarak açık olmadığı durumlarda ortaya çıkar.
Bu çeşitli şekillerde gerçekleşebilir:
Yazım yapısı veya biçimi: Bu öznel bir kelime gibi görünse de, bir el kitabının yazılış şekli bile kafa karışıklığı yaratabilir. Belgeleri okuyan okuyucu türünü belirlemek çok önemlidir; aksi takdirde "Geliştiriciler açıklayıcı metin yerine örnekleri tercih eder" veya "Belgelerimiz örneklerin ve görsellerin varlığına rağmen net değil" gibi sözler ortaya çıkabilir.
Kılavuzlarda düzenlenen konu: Bazen, aynı pazarda faaliyet gösteren işletmeler standart bir dokümantasyon formatı geliştirir. Şirket kılavuzlarınız buna uymazsa, okuyucu bir yabancılık hissine kapılabilir.
Örtülü terimlerin aşırı kullanımı: Bir el kitabına uygulandığında, ifadeler kısaltma olmasa bile kısaltmalar çok az anlam ifade edebilir. Algılanması zordur, ancak "statü", "kimlik", "kimlik bilgileri" gibi bazı kelimeler açık gibi gizlenmiş örtük bir anlam içerir. "UID" yerine "UserID" gibi belirli tanımlamaları kullanın.
Geçerli çeviri: çeviri, küresel erişimin büyük bir parçasıdır. Çoğu zaman şirketler, belirli ulusların kültürüne uymayan veya sadece kelimelerin İngilizce'de o ülkeye aynı şekilde çevrilmediği, kötü çevrilmiş kullanım kılavuzları ve ürün belgeleri oluşturur. Bu ince nüansları anlamak, ürün dokümantasyonunu okunamayan bilgilerden tamamen kapsamlı ve tercüme edilmiş bir ürün dokümantasyonuna uzun bir yol kat ettirebilir.
Bu tür durumlardan kaçınmak için amaç, kullanıcı geri bildirimlerini ve gezinme modellerini toplayan ve analiz eden bir çözüm geliştirmektir.
Vocally a Docsie özelliği gibi geri bildirim araçları, gezinme kalıplarını almak ve değerlendirmek ve müşterilerinizin ürün belgelerinizi nasıl görüntülediğini araştırmak için harika bir yoldur. Geri bildirim toplamanın 7 altın kuralını buradan öğrenin
Bu bilgiler, müşterilerinizin ürünleriniz hakkında bilgi edinmesi için daha sorunsuz bir deneyim yaratmak amacıyla kullanıcı kılavuzlarınızı, kullanım kılavuzlarınızı ve ürün belgelerinizi güncellemek ve optimize etmek için kritik öneme sahiptir. Hiçbir şey yeni bir ürün sunmaktan ve yetersiz kılavuz talimatları nedeniyle Destek taleplerinde bir artış keşfetmekten daha sinir bozucu olamaz.
Kapsamlı Ürün Dokümantasyonu Nasıl Yazılır
Kaliteli ürün dokümantasyonu büyüleyici, kullanışlı ve güçlüdür. Usta bir dokümantasyonun iyi bir ürün yönetiminin gerekli bir bileşeni olduğunu iddia ediyorum. Her ne kadar ürün yöneticileri ürünlerin geliştirilmesinde büyük rol oynasa da, başarının önemli bir parçası da müşterilerimizin anlayabileceği ve ürünlerimiz hakkındaki bilgilerini ilerletmek için kullanabilecekleri harika cilalı ürün dokümantasyonu oluşturmaktır.
Ürün belgelerinin çoğunda neler oluyor?
Birçok ürün yöneticisi ürün belgeleri hazırlamaktan kaçınır. Aşina oldukları ürün dokümanları, çekici, okunması ve ilişki kurulması kolay olmasına daha fazla özen gösterilmediği sürece müşterilerinin ilgisini çekmeyebilir.
Ancak, şirketler çoğu zaman harika ürün belgeleri oluşturmak ve hazırlamak için gereken özeni göstermezler. Kötü ürün dokümantasyonu, sadece yazılmış olmak için yazılır. İzleyicileri materyalle etkileşime girmekten caydırmak için belirsiz kabul edilebilir düşüncelerle dolu geniş ifadeler ve zayıf düzen kullanır. Kötü bir ürün dokümantasyonu, yazarı eleştirilerden korumak için oluşturulur ve herkesin zamanını tamamen boşa harcar. Ve müşterileri de bu nedenle okumaktan hoşlanmaz.
Bunu nasıl düzeltebiliriz ve müşterilerimizin okumaktan keyif alacağı daha iyi ürün belgeleri nasıl yazabiliriz?
Mükemmel ürün belgeleri okunmak amacıyla yazılır. Kısa ve özdür. İyi ürün dokümantasyonu iyi biçimlendirilmiştir ve şirketteki herkes veya müşteriler tarafından üç dakika içinde okunup anlaşılabilir. Jargondan kaçınır ve iş düzeyinde bir bakış açısı sunar ya da bu bakış açısına atıfta bulunur. Mükemmel bir ürün dokümantasyonu, müşterilerin anlayabileceği ve ürünün gelişmiş kullanımına uygulayabileceği belirli kullanım durumlarını özetlemek için zaman harcar. Okuyucunun ilgisini çeker ve iyi hazırlanmış çözümlerle altta yatan sorunlara dikkat çeker.
İyi yazılmış bir ürün dokümantasyonunun gücü
Küçük, orta veya büyük ölçekli işletmelerde, iyi biçimlendirilmiş teknik ürün belgeleri çok zaman kazandırabilir ve çalışanların daha verimli çalışmasına yardımcı olabilir. Bu durum genellikle, bütçelerinin büyük bir kısmını teknik yazarları işe almak ve teknik ürün belgeleri yazmak için harcayan çoğu ürün tabanlı işletme için geçerlidir.
İşletmenizde ürün dokümantasyonu oluşturmak için ikiden fazla kişi çalışıyorsa, iyi bir dokümantasyon kültürü oluşturmak tamamen faydalı olacaktır. Ekibinizin iyi hazırlanmış ürün dokümantasyonu oluşturmasını, yönetmesini ve yayınlamasını istemeniz için birçok neden vardır, ancak aşağıdaki bölümde etkili ürün dokümantasyonunun müşteri deneyimini iyileştirmek için nasıl düşük maliyetli bir yaklaşım olduğunu ele alacağız.
Etkili ürün dokümantasyonu, müşteri deneyimini iyileştirmek için düşük maliyetli bir yaklaşımdır
Sağlam müşteri deneyimi, sadık müşterileri elde tutmanın ve korumanın ön saflarında yer alır. Çoğu proje yöneticisi iyimserdir - bir konsept bulurlar, heveslenirler ve ardından uygulamaya geçerler. Tutku takdire şayan ve uygulama verimli görünse de, uygun ürün dokümantasyonunu uygulamadan önce bir oyun planına sahip olmak hayati önem taşır.
Bir oyun planı üzerinde beyin fırtınası yaptıktan sonraki ilk adımlar, bir tasarım döngüsü başlatmak ve ürün dokümantasyonu içeriğini müşterilerinin okumasını giderek kolaylaştıracak şekilde yapılandırmaktır.
Ayrıca, mevcut dokümantasyonları hakkında müşterilerinden geri bildirim almak, dokümanları müşterilerin ihtiyaçlarına göre yeniden yapılandırmak için gereken hayati bir adımdır. Bu şekilde proje yöneticileri algı ve otomasyon ile dokümantasyonlarını oluşturabilir, yönetebilir, bakımını yapabilir, yayınlayabilir ve optimize edebilir. Bu basit ve küçük bir görev değildir ve ürün dokümantasyonunu etkili hale getirmek için birçok süreci otomatikleştiren Docsie gibi harika araçlara sahip olmak başarı için oldukça önemlidir.
Çekici, ilgi çekici ve gezilebilir teknik belgeler, tüketicilerin ürünü daha kısa sürede öğrenmesine yardımcı olarak ürünü doğru şekilde kurma ve doğru şekilde kullanma olasılığını artırır.
İyi cilalanmış ürün belgeleri oluşturmaya yönelik tüm bu stratejiler esasen daha yüksek puanlı ürünlere, daha olumlu yorumlara ve daha fazla satışa yol açacaktır; bu nedenle, sonuç olarak artan satışları söylemeye gerek yoktur.
İyi hazırlanmış ürün belgeleri nasıl oluşturulur?
Etkili dokümantasyon nasıl üretilir ve bunun standart olduğu bir kültür nasıl teşvik edilir? Etkili dokümantasyon yazmak zordur, ancak Docsie içinde iyi hazırlanmış ve dinamik ürün dokümantasyon portalları oluşturma sürecini başlatmaya yardımcı olabilecek birçok iyi özellik vardır. Aşağıda konuya nasıl yaklaştığımızın üst düzey bir özeti yer almaktadır.
Şimdi başlayalım:
Sayfa sınırlamaları okunabilirliği sağlar. İyi bir belge yazmak, okunması ve zihinsel olarak işlenmesi zor olmamalıdır. Uzun, dolambaçlı ifadeler sıklıkla netlik eksikliğinin göstergesidir. İletişim tek bir sayfada düzgün bir şekilde özetlenemiyorsa, bu, ürün yöneticisinin muhtemelen geri dönüp durumu daha da ayrıştırması gerektiğinin bir göstergesidir.
Biçimlendirme kaliteyi artırır. Kötü yapılandırılmış bir ürün dokümantasyonu, yazarın işi savsaklaması olasılığını artırır. İyi biçimlendirilmiş bölümler, tablolar ve belge başlıkları içeren bir şablon oluşturun. Bu, yüksek getiri potansiyeli olan tek seferlik bir yatırımdır.
Şablonlar zaman kazanmanıza yardımcı olur. Bir şablondan bir bölümü silmek, bir bölüm eklemeyi hatırlamaktan çok daha kolaydır. Bu patronluk taslamak değildir; aksine etkili ve zaman kazandırıcıdır. Yazara geniş bir arka planla başlamasını ve ölçümler ya da tehlikeli varsayımlar hakkında spesifik olmasını hatırlatan basit bölümler, daha hassas yazım ve karar hiyerarşisi sağlar.
Yorum yapın ve görev verin Personelinizin motivasyonunu yüksek kaliteli dokümantasyon üretmekten alıkoymanın, onlara yorum yapmamaktan daha kesin bir yolu yoktur. Yorumların çok akıllıca olması gerekmez; daha ziyade katılımı göstermeli ve bir model olarak hizmet etmelidir. Şirketteki diğer kişilerin eşzamansız olarak sohbetten faydalanabilmesi için dijital olarak geri bildirim sağlamak ideal olsa da, Docsie'de ekibinizle yorum yapmanıza ve işbirliği yapmanıza olanak tanıyan basit bir özellik, ürün dokümantasyon ekibini harika bir şekilde çalıştırır!
Docsie'nin Ürün Dokümantasyonu İşbirliğine nasıl yardımcı olduğu hakkında daha fazla bilgi edinmek için bu bloga göz atın
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Belge türleri şirketinizin taleplerini karşılayacak şekilde ölçeklenebilir olmalıdır. Ürün geliştirme sürecine daha fazla paydaş dahil oldukça, iletişim birkaç belgeye bölünmelidir (özellikle tek sayfalık 'özlülük' kriteri karşılanacaksa). Docsie, büyüyen ürün dokümantasyon ekipleri için kullanışlı ve sürdürülebilir bir çözüm sağlar.
Docsie'yi harika ürün belgeleri oluşturmayı hızlandırmanın bir yolu olarak kullanın
Docsie, ürün dokümantasyonu ve bilgi portalı oluşturmanın her alanında size yardımcı olan çok kullanışlı bir platformdur. Ürün dokümantasyonu oluşturma projelerini oluşturmayı, yayınlamayı, sürdürmeyi ve yönetmeyi gerçekten basit ve eğlenceli hale getiren birçok yerleşik özelliğe sahiptir! İşte Docsie'nin bu hedeflere ulaşmanıza yardımcı olabilecek birçok özelliğinden sadece birkaçı:
Düzenleme imkanı: Docsie, tüm kullanıcılarımızın ürün belgelerini yayınladıktan sonra, etkin olana kadar yayına girmeyecek alternatif bir sürüm oluşturarak düzenlemelerine olanak tanır. Bu harika bir şey çünkü ürün yönetimi ekipleri ürün belgelerini düzenlemek ve değiştirmek için çalışabilir ve bunu yapmaya hazır olduklarında HTML ve CSS çemberlerinden atlamadan canlı hale getirebilirler. Hazır olduklarında ürün belgelerini otomatik olarak bir düğmeye basarak oluşturacaklardır.
Arama yeteneği: Ürün belgeleriniz bol miktarda veya çok sayıda özellik varsa, Docsies arama eklentisi reklamları, müşterilerinizin ürün belgelerinizden bilgileri önizledikleri ve özümsedikleri süreci hızlandırmak için ihtiyaç duydukları bilgileri bulmak için belgelerinizde hızlı ve kolay bir şekilde arama yapmalarını sağlayan yararlı bir bonus.
Bağlantı kurma imkanı: Docsie, ürün belgelerinizi SEO dostu hale getirir. Şirketlerinizin web sitesindeki belirli sayfalara geri bağlantı verebilir veya ürünlerinize dayalı anahtar kelimeler yazabilirsiniz, bu da çevrimiçi olarak aranabilir olacak ve sahip olduğunuz aynı ürünü bulmak isteyen yeni müşterileri çekecektir.
Farklı çevirilere sahip olma imkanı: Docsies'in son teknoloji hayalet çevirmeni, kullanıcılarımızın ürün belgelerini çeşitli dillere çevirmelerine olanak tanır. Ayrıca, Docsie'nin dil seçici özellikleri sayesinde müşterileriniz kendilerine en uygun dili seçebilir. Bu, küresel erişim ve şirketlerin müşteri tabanını genişletirken, yeni kurulan müşterileri ve denizaşırı müşterileri ile güven inşa etmek için oldukça yararlıdır.
Sorunsuz işbirliği için görev atama ve yorum yapma olanağı: Docsie, ürün dokümantasyon ekibinizle işbirliği yapmak için harika araçlara sahiptir. Docsie ile ürün dokümantasyon projeniz üzerinde çalışan hangi kullanıcının hangi görevleri yerine getirdiğini daha iyi yönetebilmek için yorumlar atayabilir, görevler belirleyebilir ve roller atayabilirsiniz. Daha fazla bilgi edinmek için bu bloga göz atın
Geri bildirim oluşturma: Müşterilerinizin dokümantasyonunuz hakkında ne düşündüğünü bilmek, ürün dokümantasyonunuzu müşterilerinizin ihtiyaçlarına göre nasıl optimize edeceğinizi bilmenin tek yoludur, böylece ürün dokümantasyonlarınızı ve bilgi portallarınızı daha keyifli bir şekilde anlayabilirler Ürün dokümantasyonu geri bildiriminin önemi hakkında daha fazla bilgi edinmek için lütfen buradaki bloguma göz atın
Docsie'nin size ve ürün yönetimi ekibinize harika ürün belgeleri oluşturmak için kullanmanıza izin verdiği başka birçok özellik ve yetenek de vardır. Bu makalede, her Docsie bilgi portalı ve ürün dokümantasyonunun, dokümantasyonlarını geliştirmek ve tüm kullanılabilirliklerini artırmak için ekleyebileceği eklentilere değinmek istiyorum.
Dokümantasyon portalınızı dinamik hale getirmek için Docsie eklentileri! Docsie, dokümantasyonunuzu daha çekici hale getirmek için kullanabileceğiniz bir dizi eklentiye sahiptir. Bu blogda bunu 3 bölüme ayıracağım.
Bu bölümde bu bilgi portalı eklentilerinin açıklamasını üç bölüme ayıracağız.
1. BÖLÜM: İlk bölümde 'Sürüm Seçiciyi Görüntüle', 'Dil Seçiciyi Görüntüle', 'Bölüm Çapalarını Görüntüle' ve 'Altbilgi Gezinmesini Görüntüle' işlevlerinin ne olduğunu göstereceğiz.
BÖLÜM 2: Bu bölümde 'Kod Vurgulama', 'Arama' ve 'Sosyal Ağda Paylaş' eklentilerini göstereceğiz
3. BÖLÜM Üçüncü bölümde 'Görüntü Önizleme', 'Belge Meta Verileri' ve 'Otomatik Vurgulama Bölümü' eklentilerini göstereceğiz.
Eklentilere geçmeden önce Docsie Platformunda bu eklentilere nasıl erişileceğinden bahsedelim.
İlk olarak, çalışma alanında sağ üst köşedeki üç noktaya tıklayıp hesabımızı açmamız gerekiyor:
Daha sonra Dağıtımlar içinde 'Yeni bir dağıtım yapılandır+' aracılığıyla yeni bir Dağıtım oluşturduğumuzda Eklentilere erişebiliriz
Ardından 'Daha fazla seçenek' seçeneğine tıklayarak bu eklentileri gömülü bir komut dosyanız veya Docsie portalı aracılığıyla Dağıtılan belgelerinize ekleyebilirsiniz
Diğer seçenek, Docsie'nin bilgi portalları eklentilerine, halihazırda yayınlanmış belgelerinizin altındaki 'Dağıtım yapılandırmasını güncelle' düğmesi aracılığıyla erişmektir.
Bu gösterge tablosunu açacak ve ardından uygun gördüğünüz eklentileri ekleyip çıkarabilecek ve ardından dağıtımı güncelleyebileceksiniz.
BÖLÜM 1:
Artık Docsie Pluggin'e nasıl erişeceğimizi bildiğimize göre BÖLÜM 1'e geçelim.
Bölüm 1 **video eğitimini görmek için lütfen bu videoyu buradan kontrol edin:
'Ekran sürümü Seçici' ve 'Ekran Dili Seçici' ile başlayalım
Bu ikisi etkin olduğunda, bilgi portalınızın sol alt kısmında kayan sekmeler olarak görüneceklerdir. Müşterilerinizin ve ürün belgelerinizi okuyanların ürün belgelerinizi farklı dillerde ve sürümlerde görüntülemelerine olanak tanır.
Kullanıcı, dil seçicideki Dil seçeneğine bastığında, okumakta olduğu tüm dokümantasyon o dile dönüştürülecektir.
Bölüm Göster bağlantısı etkinleştirildiğinde, müşterinizin her başlığın yanında belgelerin belirli bölümlerine bağlantılar veren bağlantılara sahip olmasını sağlar.
Bu bağlantılara her basıldığında, başlığın bir kısmı değişecek ve müşteriniz bu html'i kopyalayıp yapıştırdığında, gönderdiği kişiyi belgelerin bu belirli bölümüne yönlendirecektir.
Sonraki 'Altbilgi Navigasyonunu Göster'
Bu eklenti, dokümantasyon kitabınızın sağ alt kısmına bir gezinme düğmesi ekler. Şuna benzer bir şey görünüyor.
Bu şekilde müşterileriniz belgeleriniz arasında daha rahat gezinebilir.
BÖLÜM 2:
Bölüm 2 **video eğitimini görmek için lütfen bu videoya buradan göz atın:
Bu bölümde 'Kod Vurgulama', 'Arama' ve 'Sosyal Ağda Paylaş' eklentilerini göstereceğiz
Şimdi 'Kod Vurgulama' eklentisi ile başlayalım
Bu eklenti, müşterilerine çeşitli kodları ifade etmesi gereken teknik ürünler için harikadır. Bu eklenti, bir "Kopyala" düğmesi ekleyerek müşterilerinin kendilerine tahsis edilen kodu kopyalayıp yapıştırmalarına ve böylece editörlerinde kullanım kolaylığı sağlamalarına olanak tanır.
Şimdi Arama eklentisine geçelim.
Docsie'nizin bilgi portalında etkinleştirildikten sonra müşterileriniz bilgi portalının sağ üst köşesindeki bir arama navigasyonu aracılığıyla belgelerinizde arama yapabilir.
Aramaya tıkladıklarında bu, müşterilerinizin rafınızda ve kitaplarınızda belirli bilgileri tam olarak nerede bulacaklarını belirlemelerine olanak tanıyan sofistike bir gösterge tablosunu destekleyecektir.
Bu, müşterilerinizin ürünleriniz hakkında ihtiyaç duydukları bilgileri bulma ve alma sürecini oldukça hızlandırır.
Sırada Sosyal Ağlarda Paylaş eklentisi var
Bu eklenti, müşterilerinizin yazılı ürün belgelerinizin vurgulanmış bölümlerini almasına ve sosyal medyada paylaşmasına olanak tanır.
Bu harika bir şey çünkü trafiği, yeni potansiyel müşterileri ve markanıza duyulan güveni artırabilir.
BÖLÜM 3:
Bölüm 3 **video eğitimini görmek için lütfen bu videoyu buradan kontrol edin:
Üçüncü bölümde 'Görüntü Önizleme', 'Belge Meta Verileri' ve 'Otomatik Vurgulama Bölümü' eklentilerini göstereceğiz.
Görüntü Önizleme Eklentisi ile başlayalım
Görüntü önizleme, müşterilerinizin ürün belgelerinizin görüntüsünü daha iyi görüntülemek için yakınlaştırmasına veya uzaklaştırmasına olanak tanır.
Sırada 'Dokümantasyon meta verileri' var
Bu, müşterilerimizin ürün belgelerinin veya bilgi portalının unsurlarının güncellendiği zaman damgasını görmelerini sağlar. Yazılı belgelerin üst ve alt kısmında yer alacaktır.
Şimdi 'Otomatik Vurgulama Bölümü Eklentisi'ne bakalım
Bu basit eklenti, müşterilerinizin bilgi portalında belirli bir belgede nerede olduklarını takip etmelerini sağlar.
Bilgi portalı içinde bulundukları her konumu vurgulayacak, böylece yo8ru müşterileri hangi bölümde olduklarını daha iyi takip edebilecek ve diğer bölümlere daha kolay geçebilecekler.
Tüm bu araçlar ve daha fazlası Docsie'nin platformu tarafından size sağlanmaktadır. Eğer henüz denemediyseniz, denemenizi öneririz. Buraya tıklayın
Ayrıca herhangi bir sorunuz varsa, lütfen hello@docsie.io adresinden bize ulaşmaktan çekinmeyin.