Yeni bir ürün piyasaya sürerken en iyi uygulamalardan biri, ürün piyasaya sürme hazırlıklarını gerçekleştirmektir. Özellikle, bir ürün lansmanını desteklemek için yeni ürün belgeleri yazmaya odaklanmak istiyoruz. Bu olmadan, potansiyel kullanıcılar yeni çözümünüzü satın aldıktan sonra referans noktası olarak kullanabilecekleri ilgili bilgilere sahip olamayacaklardır.
Daha geniş bir pazarlama stratejisinin parçası olarak, ürün yöneticileri ve ürün ekibi üyeleri bir sonraki lansmanlarında izleyecekleri en iyi 15 uygulamayı öğrenmek için okumaya devam etmelidir. Sonunda, bu önemli belgeleri nasıl en iyi hale getirebileceğinizi anlayacaksınız!
Ne Tür Ürün Belgelerine Dikkat Etmeliyim?
En iyi uygulamalar listesine geçmeden önce, ne tür ürün belgelerinin mevcut olduğunu ve her biri için amaçlanan hedefi açıklığa kavuşturalım:
-
Ürün Gereksinimleri Dokümantasyonu** - Ürün gereksinimleri dokümanı veya PRD, işletmelerin sürüm kriterlerini karşılamasına yardımcı olmak için kullanılan bir tür dahili ürün dokümantasyonudur. Bu belge, nihai ürünün bir kullanıcı için neyi başarması gerektiğini açıklar ancak bunun nasıl ve nerede yapılacağını belirtmez. Ardından, geliştirme ekipleri ve test ekipleri, ürünü piyasaya sürülmeye hazır iş gereksinimleriyle uyumlu hale getirmek için bir PRD kullanır. PRD'ler yazılım ürünlerinde yaygındır, ancak herhangi bir ürün yol haritasına uymak için kullanılabilir.
-
Kullanıcı Kılavuzları ve Self Servis - Ürün ekiplerinin, başarılı bir ürün lansmanı için yumuşak bir ön koşul olarak kullanıcı kılavuzları oluşturması gerekecektir. Adından da anlaşılacağı üzere bu, son kullanıcıların yeni bir ürünü kullanırken verimliliklerini en üst düzeye çıkarmalarına yardımcı olacak dokümantasyondur. Burada, kullanıcıya yönelik tüm önemli işlevler eksiksiz olarak açıklanmalıdır, böylece müşteriler en yüksek değeri elde edebilir. Daha da iyisi, müşterilerin kendilerine yardımcı olabilmeleri için bu kılavuzları self servis harici bir bilgi tabanında paylaşın!
-
Kurulum, Yükleme ve Yapılandırma Kılavuzları** - Bir ürün kurulum, yükleme ve yapılandırma gerektiriyorsa, bu, oluşturmanız gereken başka bir teknik ürün dokümantasyon varlığıdır. Amaç, bu süreçleri kullanıcı perspektifinden ve varsa geliştirici perspektifinden net bir şekilde göstermektir. Bu, yazılım dokümantasyonu için birden fazla cihaza ve birden fazla işletim sistemine yayılabilir; akılda tutulması gereken bir şey.
-
Pazarlama Varlıkları - Bunun ürün dokümantasyonu olduğunu düşünmeyebilirsiniz, ama öyle! Pazarlama varlıklarının tarzı ve biçimi, müşterilerin ürününüzü kullanmaya başlamadan önce nasıl algıladıklarını etkiler. İyi bir izlenim bırakmak hayati önem taşır. Ürünün yeni özelliklerini nasıl anlatıyorsunuz? Hangi kitleye yönelik? Bu, birinin iş veya kişisel hayatını nasıl iyileştirecek? Sizin ve daha geniş anlamda şirketin müşterilerin düşünmesini istediği şey bu mu?
Yeni Ürünler Piyasaya Sürülürken Dokümantasyon için 15 En İyi Uygulama
Ürün dokümanlarıyla ilgili bu başlangıçtan sonra sırada en iyi uygulamalar listesi var:
1: Bir Başlangıç Yapın!
Ürün dokümantasyonuna yeni mi başlıyorsunuz? Harika! Şimdi, bir başlangıç yapmaktan çekinmeyin. Birçok kişi ürün dokümantasyonunu MÜKEMMEL hale getirmek ister ve mükemmellik peşinde koşarken bu görev karşısında felç olur. Hizmetleriniz için temel konsepti kağıda dökün, ardından müşterilerinizi etkilemeye hazır hale getirmeye odaklanın. Sürüm notları temelleri tanımlamak için harikadır, daha sonra bu belgeden yola çıkarak geliştirebilirsiniz.
2: Basit Tut, Aptal...
KISS olarak kısaltılan bu ilke, 60'lı yıllarda ABD donanmasında kullanılan gerçek bir tasarım ilkesidir. Aynı kural ürün dokümantasyonu için de geçerli olabilir. Kendinize şu soruyu sorun: "Gerekli bilgileri tüm demografik grupların anlayabileceği bir şekilde nasıl aktarabilirsiniz?"
Bunu ürün vizyonunuza uygulamak için Flesch-Kincaid okunabilirlik testini öneriyoruz. Grammarly gibi içerik derecelendirme araçları genellikle bu sistemi kullanır. Bu, yazılı içeriği analiz ederken size ABD lise notuna eşdeğer bir puan verir. İçeriğin yorumlanabilirliğini en üst düzeye çıkarmak için okul yaşı olarak 8. sınıf veya 13-14 yaşı hedefleyin - bekleyin, yazınızı anlamanın ne kadar kolay olduğunu söyleyebilirdik.
3: Hedef Kitleyi Anlayın
Yani, başladınız ve basit tuttunuz. Şimdi, aslında kimin için yazdığınızı bilmeniz gerekiyor... Örnek olarak, yazılım şirketlerinin hedef kitlesi bir otomotiv üreticisinden çok farklı olacaktır.
Küçük yaştaki öğrencilerin kavramları adım adım öğrenmelerine yardımcı olacak basit araçlara odaklanan bir eğitim yazılımı şirketi hayal edelim. Aklınızdan geçen ilk düşünce "hedef kitle çocuklar, değil mi?" olabilir. Şart değil... Hedef kitle, BT departmanı ve satın almadan sorumlu iç paydaşlar gibi bir anaokulu veya lisedeki yazılım paketleri için birincil karar vericidir. İkincil hedef kitle ise, eğitim yazılımını vahşi doğada görüp okullarında kullanılmasını savunabilecek genç öğrenciler olabilir.
4: Bir Hikayeden Çok Değere Odaklanın
Herkes iyi bir hikayeyi sevse de, müşteriler ürününüzün ne gibi bir değer sunacağını bilmek ister. Bir görevi veya iş akışını basitleştirecek mi? Sadece çevrimiçi olan rakiplerinize kıyasla ürününüz çevrimdışı olarak mevcut mu? Ürününüz bir işi diğer rakip ürünlerden daha mı hızlı yapıyor?
Bu örnekler, belirli bir teklif için benzersiz satış noktalarını (USP) oluşturur. USP'lere odaklanmak ve bunları vurgulamak potansiyel müşterileri cezbedecek ve pazar payınızı artırmak için diğerlerinde olmayan nelere sahip olduğunuzu anlamalarına yardımcı olacaktır. Sektörünüzdeki rakiplere karşı bir rekabet analizi yaparak USP'leri tanımlayabilirsiniz.
5: Bilgileri Kategorilere Ayırmak için Biçimlendirmeden Yararlanın
Dokümantasyon büyük bir metin bloğu olmamalıdır. Bu, son kullanıcılar için taraması ve gezinmesi zor bir durumdur. Bunun yerine, metni bölmek için başlıklar ve diğer biçimlendirme seçeneklerini kullanın.
H1 başlıkları, insanların bir sayfaya tıkladıklarında gördükleri ilk şeydir. H2 ve H3, sayfada ele alınan konular için alt başlıklar olarak işlev görür. Kolay okuma için içeriği bir arada gruplamak üzere madde işaretleri veya numaralandırılmış listeler kullanabilir ve hatta SEO ve SERPS görünürlüğünü artırmak için Zengin Parçacıklar için uygun hale gelebilirsiniz. Markdown bilginiz varsa, Docsie gibi çevrimiçi bir markdown editörü, ürün belgelerinizi öne çıkarmak için çok sayıda biçimlendirme seçeneği sunar!
6: Belgelerinizi Merkezi Bir Konumda Tutun
Teknik dokümantasyonu yayınladıktan sonra uzun vadede izlemenin ve yönetmenin ne kadar karmaşık olacağını fark etmekten daha kötü bir şey yoktur. Belgelerin güncellenmesi gerekirse ne olacak? Orijinal belge nerede ve sayfanın yeni sürümlerini nasıl yayınlayabiliriz? Bu içeriği diğer dillere çevirmeye ne dersiniz?
Bu en iyi uygulama için Docsie'den bahsetmeliyiz! Çevrimiçi bilgi tabanı yazılımı, belgeleri tek bir merkezi bulut konumunda saklamanıza olanak tanır. Buradan, çalışanlar ve yükleniciler, lansmana hazır tamamlamayı hızlandırmak için içerik üzerinde işbirliği yapabilirler. Docsie, bilgiyi güncellemeniz gerektiğinde sürüm kontrol yönetimi ve küresel içerik yerelleştirmesi için dil yönetimi sunar. Küresel içerik oluşturmayı otomatikleştirmek istiyorsanız, arka planda sizin için doğru bir şekilde çeviri yapan şık bir hayalet yapay zeka dil çeviri botumuz da var!
7: Bir Resim Binlerce Sözcük Söyler
Bir şeyin nasıl yapılacağına dair uzun soluklu bir açıklama yazmak işe yarasa da, son kullanıcılara öğretmek için etkili bir yol değildir. Bunun yerine onlara resimlerle, hatta hareketli resimlerle gösterin!
Her ürün belgesine eşlik eden bir eğitim videosu oluşturmayı deneyin. Bu şekilde, okumayı tercih edenler metni tarayabilirken, görsel öğrenenler videoyu tercih edebilir. Benzer şekilde, GIF'ler ve resimler, özellikle bir yazılım kullanıcı arayüzünde (UI) kullanıcıların neye atıfta bulunduğunuzu görmelerine yardımcı olabilir. Çeşitli öğrenme stillerine uyum sağlamak, daha geniş bir kullanıcı yelpazesine yardımcı olmanıza yardımcı olacak ve bu da ürününüz için daha fazla potansiyel anlamına gelecektir.
8: Öğrenme vs Hedefler vs Anlama vs Bilgi
Belgenin amacı nedir? Kullanıcı amacı, çevrimiçi ürün dokümantasyonunda kritik öneme sahiptir ve içeriğinizi kullanıcı yolculuğunun bölümleriyle uyumlu hale getirmenize yardımcı olur.
-
Öğrenme - Bir kişi bir şeyi daha önce hiç görmediyse, öğrenme içeriği temel ilkeleri anlamalarına yardımcı olur.
-
Hedefler - Bu tür içerikler kullanıcıların bir hedefe ulaşmasına yardımcı olmalıdır, örneğin 'Docsie'den PDF Dosyası Nasıl Dışa Aktarılır' gibi. Sonunda, kullanıcı hedefe ulaşmış olacaktır: bir PDF'yi dışa aktarmak.
-
Anlama - Araştırma olarak da adlandırılan bu yöntem, bir konu hakkında halihazırda bilgi sahibi olan ancak daha derinlemesine anlamak isteyen müşteriler içindir.
-
Bilgi - Kişinin bir sorusu vardır ve belirli bir cevap ister. Bu, belirli bir yerdeki gerçek zamanlı hava durumu veya 'ağaç evin nasıl inşa edileceğine' dair bir video kadar basit olabilir.
9: Aranabilir Yapın
Bu belgeyi herkese açık hale getirmeden önce, kullanıcılarınız metin içinde anahtar kelimeleri arayabilir mi?
Değilse, bunu destekleyen bir dokümantasyon platformu bulmanızı öneririz. Kullanıcılar için bir numaralı caydırıcı unsur bilgiyi hızlı bir şekilde bulamamaktır. Bu durum hayal kırıklığına, bilgiyi bulamayan müşteri destek ekibinin ek iş yüküne ve genel olarak olumsuz bir müşteri deneyimine (CX) yol açar. Eğer merak ediyorsanız Docsie global aramayı destekliyor!
10: Eyleme Geçirilebilir Geri Bildirim Toplamak için Hazırlanma
Dokümantasyon yazarları, içeriğin ilk versiyonunun ileride değişeceğinin farkında olacaklardır. Kamu dokümantasyonu görene kadar, yazarlarınız yalnızca birbirlerinden fikir ve geri bildirim alabilirler.
Belgeleriniz yayınlandıktan sonra, geri bildirim toplamanın çok önemli olduğuna inanıyoruz. Bu şekilde, yazarlarınız gerçek müşterileri ve son kullanıcıları dinleyerek içerikle ilgili olumsuzlukları olumluya dönüştürebilir. Başka bir yere bakmanıza gerek yok, Docsie'de geri bildirim toplama özelliğinden yararlanabilirsiniz!
11: Bir Konudan Bahsederken Bir Sayfaya Bağlantı Verin
Bu en iyi uygulama SEO ve web sayfası navigasyon yapılarına dayanır.
Bir anahtar kelimeden bahsettiğinizde, ona bağlantı veriyor musunuz? Diğer konulara atıfta bulunduğunuzda, kullanıcılar mevcut sayfa bağlamında diğer konuyu henüz anlamamış olabilir. Okuyucuların bir ana konu hakkında bilgi edinirken alt konulara da hızlı bir şekilde başvurabilmelerini sağlamak için dokümantasyonu olan tüm konu başlıklarına bağlantı vermelisiniz.
12: Belirsizlik Değil, Netlik
Ürün dokümantasyonu yazarken netlik belirsizliği yener. Belirsizlikten kaçınmak için sade İngilizce kullanabilirsiniz, bu da temelde kesinlikle gerekli olmadıkça jargon ve teknik dilden kaçınmak anlamına gelir. Eğer jargon kullanırsanız, hemen ardından meslekten olmayan okuyucular için basitleştirilmiş bir tanım yazdığınızdan emin olun.
"Bu belgedeki bilgileri anlamakta sorun yaşıyorsanız, lütfen müşteri destek temsilcimizden bu anlama zorluğunun üstesinden nasıl geleceğinize dair ek ayrıntılar isteyin."
"Görüntülenen içeriğin anlaşılması zorsa, müşteri desteğinden yardım isteyebilirsiniz."
Hangisini tercih edersiniz?
13: Belgeleri Daha Hızlı Hale Getirmek için Şablonlar Oluşturun
Yeni bir ürün piyasaya sürüldüğünde, dokümantasyon oluşturma sürecini hızlandırmak bir önceliktir. Bunu şablonlar kullanarak yapabilirsiniz.
Şablonlar, sayfalar için yeniden kullanılabilir bir yapı tanımlayarak yazarların daha hızlı ve daha tutarlı içerik oluşturmasına yardımcı olur. Farklı içerik stilleri için birden fazla şablon da oluşturabilirsiniz. Docsie, özel şablon desteğinin yanı sıra kullanmanız için bir dizi önceden oluşturulmuş şablon sunar.
14: Yazarlar için Bir Ses Tonu ve Stil Kılavuzu Oluşturun
Yazarlarınız ne kadar özgür hareket edebiliyor?
Ürün belgelerinin son taslaklarında tutarsızlığa yol açabileceğinden, yazarları dizginlemek önemlidir. Bunu Ses Tonu (ToV) yönergeleri ve içerik yazma stil kılavuzları ile yapabilirsiniz.
-
Ses Tonu - Önemli olan ne söylediğiniz değil... nasıl söylediğinizdir. Yazarların resmi ve düzgün mü yoksa daha gündelik mi olmalarını istiyorsunuz? Mizaha izin veriliyor mu, yoksa konular daha ciddi mi? İçeriğiniz daha konuşkan ve tutkulu mu, yoksa sadece soğuk ve sert gerçekler mi istiyorsunuz?
-
Stil Kuralları - Bu belge, şirketin misyon beyanını ve yazarların sayfaları yazarken ve biçimlendirirken belirli bir stili nasıl takip edebileceklerini açıklayabilir. Burada hedeflenecek kullanıcı personaları, meta açıklamalar gibi SEO ilkeleri ve atıf veya referans gereksinimleri (Chicago, AP Stili vb.) yer alabilir.
15: Güçlü Bir Bilgi Tabanı Platformu Kullanarak Dokümantasyonunuzu Yayınlayın
Yazılı içeriğiniz yakıtsa, mesajı eve götürmek için hangi aracı kullanıyorsunuz?
Güçlü bir bilgi tabanı platformu, kaliteli ürün belgelerinin dağıtımı için çok önemlidir. Belgeler kullanılamaz hale gelirse veya sayfalar yavaş yüklenirse, bu belgeleri oluşturmak için harcanan tüm çaba boşa gidecektir.
Mevcut belgeleri içe aktarma, dahili ekiplerle içerik üzerinde işbirliği yapma, yeni belgeler oluşturma ve düzenleme, dinamik zengin içerik ekleme ve bir bilgi sitesinde yayınlama becerisine ihtiyacınız var. Küresel içerik yerelleştirmesi için dil yönetimi ve otomatik çevirinin yanı sıra uzun vadeli belge güncellemeleri için sürüm kontrolü de kritik önem taşır.
Tahmin ettiniz! Tüm bu özellikler Docsie'de mevcuttur. Bu özellikleri bir deneyin, başlamak için Ücretsiz Sonsuza Kadar planımızı deneyin!