Bu gaf bana ürünümüze müşteri gözüyle bakmam gerektiğini öğretti. Sonra meşhur ışık düğmesi "yandı". Eğer müşterinin sorunlu noktalarına hitap eden bir ürün sunarsam ve bunu profesyonel ürün dokümantasyonu ile desteklersem, kazanan biz oluruz.
Ayrıca profesyonel, estetik açıdan hoş ve okunması kolay ürün belgeleri oluşturmanın kolay bir iş olmadığını keşfettim. Ancak doğru yapıldığında, ürün dokümantasyonu mutlu müşterileri mest edebilir ve nihayetinde gelirleri artırabilir.
Profesyonel Ürün Dokümantasyonu Oluşturmak İçin En İyi Uygulamalar Nelerdir?
Bu en iyi uygulamalar estetik açıdan hoş, bilgilendirici ve kullanımı kolay ürün belgeleri oluşturur. Bu yönergeleri izlemek, iyi bir müşteriyi mükemmel bir müşteriye dönüştürebilecek ürün belgeleri sunmanıza yardımcı olacaktır. Nihayetinde mükemmel müşteriler şirketlerin gelirlerini artırmalarına yardımcı olur ve ürün dokümantasyonu müşteri deneyiminin hayati bir bileşenidir.
1. Hedef kitlenizi anlayın ve onlara istediklerini verin
Hedef kitlenizin beklentilerinin ne olduğunu bilmek çok önemlidir](https://www.stickyminds.com/article/writing-requirements-documentation-multiple-audiences). Örneğin, ürün belgeleri Yöneticilere mi yoksa Son Kullanıcılara mı yönelik? Hedef kitlenizin kapsamı, Yöneticiler için teknik olarak veya Son Kullanıcı için açıkça tanımlanmış terimler ve talimatlarla yazmayı gerektirebilir.
Profesyonel ürün dokümantasyonu oluşturmak için en iyi uygulama, Yönetici veya Son Kullanıcı düzeyinde müşteri beklentilerini anlamaktır. Tanımlayıcı hedef kitle bilgilerini toplama yöntemlerinden bazıları şunlardır:
-
Anketler ve Anketler
-
Algılanan izleyici geri bildirimi
-
Şirket beyin fırtınası
-
Popüler müşteri görüşleri hakkında geri bildirim
-
Müşteri yuvarlak masa toplantıları
2. En iyi uygulama olarak bir dokümantasyon planı oluşturun
Bir dokümantasyon planı yazmak, proje uygulaması sırasında olası darboğazları görmeye yardımcı olabilir. Ürün dokümantasyonu oluşturmak zor olabilir ve en iyi uygulama, dokümantasyon sürecinde ortaya çıkabilecek sorunları öngörmeye yardımcı olmak için bir dokümantasyon planı oluşturmaktır.
Bir dokümantasyon planı oluşturmanın faydaları arasında aşağıdakiler yer almaktadır:
-
Yeni ürün dokümantasyon planı ile yeniden kullanılabilecek uygulanabilir bilgileri kurtarmak için mevcut dokümantasyonun denetlenmesi.
-
Şablonlara ve stil kılavuzlarına uyun - Ürün dokümantasyonu yeni bir ürün içinse, sektörün sesi ve stili içinde kaldığından emin olun veya dokümantasyon mevcut bir ürünle ilgiliyse, markanın sürekliliğini sağlamak için** mevcut stil kılavuzlarını ve şablonları koruyun.
-
Belge süreci araçları - Belge araçları, ekip çalışmasının sürekliliğini ve belge geliştirme sürecinin daha iyi anlaşılmasını sağlarken ürün belgeleme sürecini tanımlayabilir ve kolaylaştırabilir.
3. En iyi uygulama olarak ürün dokümantasyonunu basitleştirin
Kaç kullanıcının ürün belgelerini okuduğunu belirlemek için 2016 yılında bir çalışma yapılmıştır. Sonuçlar, kullanıcıların yalnızca [%25'inin ürün belgelerini okumadığını] ortaya çıkardığı için göz açıcıydı. (https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) Anket, son kullanıcıların ürün belgelerini okumamasının kısmen aşağıdakilerden kaynaklandığını ortaya koydu:
-
Kullanıcılar sabırsızdır - Web üzerinden anında bilgi edinmenin ortaya çıkmasıyla birlikte, kullanıcılar sorunlarına yanıt bulma konusunda genellikle daha az sabırlı hale gelmektedir. Ürün belgelerini çevrimiçi veya çevrimdışı okumak, belirli bir ürün için gereken çok sayıda bilgi nedeniyle zahmetli olabilir.
-
Skip-ahead sendromu - Kullanıcılar genellikle gerekli ürün belgelerini atlayarak doğrudan ürünün nasıl kullanılacağına ilişkin temel bilgilere geçerler. Kullanıcılar, ürünlerin nasıl çalıştığını ayrıntılı talimatları okumak yerine ürünle etkileşim yoluyla öğrenir ve anlar. Talimatlar mümkün olduğunca açık ve bilgilendirici olmalıdır.
-
Kafa karıştırıcı düzen ve yapı - Kılavuzlar genellikle anlaşılması ve takip edilmesi zor bir formatta yazılır. Birçok kullanıcı, ürün belgelerini kafa karıştırıcı veya sorularıyla alakasız bulmakta, hayal kırıklığına uğramakta ve kılavuzu okumaktan vazgeçmektedir. Çoğu zaman, şirket ayrıntılı bir hedef kitle araştırması yapmamış ve kullanıcının neye ihtiyacı olduğunu doğru bir şekilde anlamamış ve okumayı bitiremeyecek kadar kafası karışmıştır.
4. Ekran görüntülerini ve grafiksel bilgileri ekleyin
Ürün dokümantasyonunu, ürün hakkında bir hikaye anlatan bir yol haritası olarak düşünün. Müşteriyi ekran görüntüleri veya diğer grafiklerle kolayca tanımlanabilen bir yolda yönlendirin](https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250) ve her farklı grafiğin diğeriyle nasıl etkileşime girdiğini gösterin. Kullanıcının neye baktığını veya bir özellik etkinleştirildiğinde ürüne nasıl tepki verdiğini ve bundan sonra ne bekleyeceğini net bir şekilde açıklayın. Her bir grafiğin amaca yönelik olduğundan ve ürünün iş akışının birbiriyle uyumlu çalıştığından emin olun.
5. Konuları daha kesin bir şekilde anlamak için çapraz bağlantıları kullanın.
Ürün belgelerini okurken çapraz bağlantıların çok değerli olduğunu gördüm Bir özellik veya işlev sürecinin ne yaptığını anlamak, ilişkili bir konuyla çapraz bağlantı kurmaya büyük ölçüde yardımcı olur. Buna ek olarak, ilişkili veri noktalarının çapraz bağlanmasıyla, sistemin nasıl etkileşime girdiği ve iş akışına ilişkin genel resim daha belirgin hale gelir.
6. Ürün dokümantasyonu için KISS ilkesini unutmayın.
Dokümantasyon oluştururken KISS (Keep It Simple, Stupid) ilkesini kullanmayı unutmayın. Bununla birlikte, süreci kapsamlı bir şekilde belgelemek önemlidir, ancak aşırı belgeleme noktasına gelmemelidir. Buna ek olarak, dokümantasyon kullanıcısı belirli öğeler hakkında belirli bilgileri arıyor olabilir, bu nedenle KISS ilkesine bağlı kalmak dokümantasyonda çok daha kolay gezinme ve anlama sağlar.
Örneğin, bir işlevi açıklamak için basit notasyonlar yeterli olabilir, belki de ana konuya bir referans (çapraz bağlantı) verilebilir. Kullanıcının ihtiyaçlarıyla ilgili bilgileri kolayca arayabilmesi için gerçekleri temiz tutun ve fazla abartmayın. Ürünün her yönünü okumakla ilgilenmeyebilirler.
7. Farklı öğrenme stillerine uyum sağlayın
Her insanın [farklı bir öğrenme tarzı] vardır (https://www.ukessays.com/essays/social-work/people-learn-in-different-ways.php). Bazıları derinlemesine açıklamaları tercih ederken, diğerleri grafikleri ve görsel temsilleri tercih edebilir. Bununla birlikte, bazı kullanıcılar odaklanmış okuma yerine uygulamalı katılım yoluyla daha fazla öğrenir.
Etkili ve bilgilendirici ürün dokümantasyonu oluştururken tüm öğrenme stillerini kapsadığınızdan emin olun. Örneğin, ekran görüntüleri, grafikler, yapılandırılmış metinler veya video bağlantıları gibi grafikler eklemek, tüm öğrenme stillerinin ürün belgelerini anlamasını sağlamaya yardımcı olur.
8. İlk katılım içeriğini kişiselleştirin ve yapılandırın
Ürünü [dokümantasyonu hedef kitlenin rolüne göre] kişiselleştirin (https://www.deanhouston.com/news/knowing-audience-document-right-document/). İçeriği kullanıma sunarken hedef kitlenin rollerine göre belgelerin farklı sürümlerini oluşturun. Örneğin, bir yöneticinin soruları, bir uzman kullanıcının dokümantasyonla ilgili sorularıyla alakalı olmayabilir.
Dokümantasyon, daha çok hedeflenen kitlenin rolüne yönelik olarak dokümanın biraz farklı versiyonlarını oluşturarak bir kişiselleştirme katmanı sunabilir. İlk katılım içeriğinin hedef kitlenin rolüne göre değiştirilmesi, dokümantasyona kişiselleştirme unsuru kazandırır.
9. Belirli kitleler için terimleri açıkça tanımlayın
Hedef kitleye bağlı olarak, dokümantasyon boyunca kullanılan her terimin anlamını açıklamak iyi bir uygulamadır. Hedef kitle kurum içi ise, biraz açıklama yaparak daha karmaşık terimler kullanabilirsiniz. Ancak, dış kullanıcılar belgelere eriştiğinde, kullanıcıların uzmanlığını bilmenin bir yolu yoktur.
Benzersiz veya karmaşık terimlerin net bir şekilde tanımlanması, tüm iç paydaşlar ve dış kullanıcılar için çok daha iyi ve verimli iletişim sağlar.
10. Kullanıcı geri bildirimi toplamak için bir yöntem sağlayın
Dokümantasyon geri bildirimi, dokümanın etkinliği konusunda güçlü bilgiler sağlar. Dokümantasyonun kalitesi hakkında değerli bilgiler toplamak için bir bağlantı veya "Beğen/Beğenme" içeren basit bir düğme sağlayın. Kullanıcı geri bildirimi toplayarak](https://www.k15t.com/rock-the-docs/documentation-guide/collaborative-writing/collect-user-feedback) dokümantasyon iyileştirilebilir ve geliştirilebilir.
11 Düz bir yapıya sahip dokümantasyondan kaçının
Ürün dokümantasyonu oluştururken, dokümantasyonun "düz bir yapı" olarak yazılmadığından emin olun. Düz metinlerle dolu bir belgeyi okumak zahmetlidir ve aynı zamanda sıkıcı olabilir. Buna ek olarak, bilgiler tartışılan konuyla ilgiliyse ve okuyucu bunları hızlı bir şekilde tüketebiliyorsa okuyucunun belgelere olan ilgisi artacaktır.
Daha iyi bir kullanıcı deneyimi sağlamak için seçilen bilgileri vurgulayarak veya videolar, resimler, bağlantılar ve diğer yöntemleri entegre ederek sürekli, düz metni parçalara ayırın. Buna ek olarak, belge içeriğini "ısırık büyüklüğünde" parçalar halinde sunarak okuyucu daha keyifli bir deneyim yaşayacak ve belgeleri okuma konusunda daha az isteksiz olacaktır.
12. SEO dostu dokümantasyon oluşturun
En iyi çevrimiçi ürün dokümantasyonu uygulaması, [dokümantasyon SEO dostu] bir tarzda yazıldığından emin olmaktır (https://www.pragm.co/post/making-your-documentation-seo-friendly). Belgelerin, belgeleriniz için internette arama sonuçlarını en üst düzeye çıkaracak şekilde yazılmasını sağlamak. Müşterilerin belgelerini aramaları gerekebilir ve barındırma sitesine açık bir bağlantıya sahip olmadıklarında, arama terimleri girerek, SEO dostu olduğunda yanıtlar daha hızlı ve daha özlüdür.
13. Ürün belgelerini güncel tutun
Ürün dokümantasyonunun bakımı, özellikle de çevrimiçi erişim söz konusuysa çok önemlidir. Genellikle bir ürünün gereksinimleri değişir ve çevrimiçi belgeler yeni değişiklikleri veya güncellemeleri yansıtmalıdır. Bu nedenle, kullanıcı belgelerinin güncel olması ve son güncellemeler için yenilenmesi ve müşterinin ürün belgelerindeki değişikliklerden haberdar olmasını ve bilgilendirilmesini sağlaması gerekir.
14. Kullanıcıların ürün belgelerini okumayabileceğini anlayın
2014 yılında yapılan bir araştırma, kullanıcıların ürün belgelerinin tamamını](https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) okumadığını ortaya koymuştur. Belgeleri okumamanın başlıca nedenleri şunlardı:
-
Ürün dokümantasyonu aşırı karmaşıktı
-
Belgeler sorularını doğrudan ele almadı
-
Kullanıcılar, belgeleri okumadıkları için ürünün birçok özelliğini kullanmadı
-
Birçok kullanıcı belgeleri okumak yerine "uygulamalı" öğrenmeyi tercih etti
15. Hem dinamik hem de statik içeriği yönetin
Ürün belgeleri güncellemeler, yeni özellikler, düzeltilmiş içerik, güncellenmiş bakım uyarıları ve diğer öğelerle sürekli olarak gelişmektedir. Bu güncelleme, ürünün gereksinimlerine göre sürekli gelişen, yaşayan, nefes alan bir belge olarak kabul edilir.
Statik içerik, kullanıcıya ürünün ömrü boyunca değişmeyen veriler sağlar. Statik içeriğin amacı, kullanıcılara, özellikle de yeni kullanıcılara, ürünün yaşam döngüsü boyunca statik kalan bilgileri referans olarak vermektir. Statik içerik zengin dokümantasyon için hayati önem taşır ancak genellikle dinamik dokümantasyonun arka planında yer alır.
İçerik [dinamik veya statik olarak sınıflandırıldığında] dokümantasyon setinin bakımı daha kolaydır (https://brainly.com/question/24688083). Ürün yaşam döngüsü dokümantasyonu, dokümantasyon dinamik veya statik olarak sınıflandırıldığında daha kolay uygulanabilir ve doğrulanabilir. Yeni özellik güncellemeleri (statik) veya ayrıntılı ürün güncellemeleri (dinamik) için dokümantasyonda küçük değişiklikler olabilir.
16. Ürün belgelerinin kullanılabilirliği için en iyi uygulamalar
Kullanıcılar çok fazla ürün dokümantasyonu okumasalar da, ihtiyaç duyduklarında bunu hemen isterler. Dokümantasyon için geleneksel dağıtım yöntemi, ürünle birlikte seyahat eden basılı bir kılavuza sahip olmaktı. Ancak günümüzün dijital ve çevrimiçi dünyasında dokümantasyon genellikle web üzerinden sağlanmaktadır.
Ürün dokümantasyonunun nasıl sağlandığına bakılmaksızın, kolay erişilebilir erişim noktalarına sahip olmak çok önemlidir. Bu nedenle, günümüzde dokümantasyon sağlamanın baskın yöntemleri şunlardır:
-
Çevrimdışı dokümantasyon - Birçok ürün basılı kılavuzlar veya "Hızlı Başlangıç" kısayol sayfalarıyla birlikte paketlenir. Bu belgeler genellikle "tek seferliktir" ve kolayca dağıtılamaz. Bununla birlikte, birçok kılavuz isteğe bağlı olarak, taşınabilirliği veya talep üzerine yazdırma seçeneğini teşvik eden kapsüllenmiş bir PDF formatında sağlanır.
-
Çevrimiçi dokümantasyon- Google'da bir sorunun cevabını aradığınız her seferinde, muhtemelen bir çevrimiçi dokümantasyon parçacığı yakalıyorsunuzdur. Web'in ortaya çıkışı, son kullanıcılar için basılı kılavuzların veya ürün dokümantasyon materyallerinin yerini almıştır. Çevrimiçi dokümantasyonun faydalarından bazıları şunlardır:
-
Uzaktan Çalışma - Pandeminin bize öğrettiği bir şey, evden çalışmanın ofis kadar verimli olabileceğidir, özellikle de sorularımız çevrimiçi belgelerle yanıtlandığında.
-
İşbirliği - Kolayca erişilebilen bir çevrimiçi dokümantasyon portalı ile ekip üyeleri anında bilgi paylaşabilir ve ofiste genellikle imkansız olan ekip çalışmasını oluşturabilir.
-
Mobil dostu - iPad'ler ve akıllı telefonlar gibi mobil cihazların ortaya çıkışı, günlük etkileşimler için yavaş yavaş PC'lerin yerini aldı. Bir akıllı telefonla çevrimiçi belgelere kolayca erişebilir ve rahatsız edici ürün sorunlarını öğle yemeği sırasında en sevdiğiniz kafede bile kolayca araştırabilirsiniz.