Ürün ekipleri ve yazılım ekiplerinin ortak bir sorunu vardır: dokümantasyon.
Ürün dokümantasyonu, bir ürünün iş akışını ve kullanıcı arayüzünü açıklayan kullanıcıya yönelik kılavuzları ve rehberleri ifade eder. Ortalama bir kullanıcı bu ürünle nasıl üretken olabilir? Bu anlamda ürün dokümantasyonu yazılım ürünleri için kullanılabilir.
Yazılım dokümantasyonu, bir yazılım ürününün altında yatan teknolojileri, ön koşulları ve yapılandırılabilir nitelikleri ifade eder. BT yöneticileri yazılım ürününü kullanıcılar için nasıl yapılandırır, izler, barındırır ve dağıtır? Bu tür dokümantasyon, özellikle de birden fazla sürüm veya dal karışıma eklendiğinde önemlidir.
Ürün dokümantasyonu bir anlamda birine araba kullanmayı öğretmek gibidir. Tekerlek arabayı döndürür, gaz pedalı arabayı hareket ettirir, fren pedalı arabayı durdurur. Yazılım dokümantasyonu birine arabanın nasıl çalıştığını öğretir. Tekerlek ön aksa bağlıdır ve ön lastikleri döndürerek aracın gidişatını değiştirir; gaz pedalı motora giden hava akışını artırarak daha fazla yakıt çekilmesini sağlar, tork ve beygir gücü üretir.
Her iki dokümantasyon türü de önemlidir. Biri kullanıcıları eğitir, diğeri ise yöneticileri ve geliştiricileri eğitir. İnsanlara bir arabayı nasıl kullanacaklarını göstermek harikadır, ancak kimse arabanın nasıl çalıştığını bilmiyorsa, araba bozulduğunda ne olur?
Ürün ve Yazılım Belgeleri Arasındaki Küçük Farklar
Ürün ve yazılım dokümantasyonunda dikkat edilmesi gereken küçük farklılıklar vardır:
Yazılım ve Ürün Dokümantasyonu: Hedef Kitle ve Persona
Ürün dokümantasyonu tek bir kitleye hitap eder; kullanıcı. Kullanıcının teknik bilgiye sahip olmadığını varsayar ve minimum jargonla sade bir İngilizce ile iletişim kurar. Üniversite diplomasına karşı teknik çıraklık gibi, teorik veya kavramsal bilgiye daha az odaklanarak insanları işlerin nasıl yapılacağı konusunda eğitir.
Yazılım dokümantasyonu BT yöneticilerini, mühendisleri ve geliştiricileri hedefler. Yazılımın tasarımı ve mimarisi, komut satırı kurulum talimatları, API ve entegrasyon desteği, veri yönetimi ve raporlama, ağ topolojisi - temelde makinenin çalışmasını sağlayan çarkları kapsar. Bu belgeler, BT personelinin yazılım uygulamasını izlerken ve sorun giderirken başvurabileceği tek bir gerçek kaynak (SSOT) oluşturur.
Yazılım ve Ürün Dokümantasyonu: Güncelleme Sıklıkları
Yazılım dokümantasyonu, ana sürüm kanalında yeni taahhütler birleştirildikçe sürekli olarak güncellenmelidir. Yazılım dokümantasyonu yeni fonksiyonları ve komutları vurgulamalı ve eski özellikleri kullanımdan kaldırmalıdır. Yeni veya değişen bağımlılıklar belgelenmeli ve tüm hedef platformlardaki özellik desteği açıklığa kavuşturulmalıdır - örneğin bir özelliğin Windows'ta çalışması ancak Linux'ta çalışmaması gibi.
Ürün belgelerinin yalnızca temel yazılım düzenlemeleri iş akışında veya kullanılabilirlikte bir değişikliği tetiklediğinde güncellenmesi gerekir. Bir geliştirici bir ödeme ağ geçidinin kodunu değiştirir, ancak kullanıcılar için ödeme süreci aynı kalır, bu nedenle güncelleme gerekmez.
Bu, yazılım ürünü dokümantasyonu için doğal bir hiyerarşi göstermektedir. Teknik yazılım dokümantasyonu temeli oluşturur ve sonraki ürün dokümantasyonu bu temele dayanır. Bu nedenle, daha da iyi ürün dokümantasyonuna zemin hazırlayacağından, mükemmel yazılım dokümantasyonuna odaklanılmalıdır.
Ürün ve Yazılım Belgeleri için Örnek Biçimlendirme Çerçeveleri
Bir ürün dokümantasyonu parçası bu çerçeveyi takip edebilir:
-
Ürün Adı
-
Ürün Amacına Genel Bakış
-
Kurulum Kılavuzu
-
Özellik 1 Açıklama ve Görseller
-
Özellik 2 Açıklama ve Görseller
-
Müşteri Destek Bağlantıları
Benzer şekilde, bir yazılım dokümantasyonu da bu çerçeveyi takip edebilir:
-
Yazılım Adı
-
Yazılım Amacına Genel Bakış
-
Yazılım Bağımlılıkları
-
Kurulum Kılavuzu
-
Fonksiyon 1 Açıklama ve Görüntüler
-
Fonksiyon 2 Açıklama ve Görüntüler
-
Teknik Destek Bağlantıları
Bu iki dokümantasyon türünün birbiriyle yakından ilişkili olduğu ve benzer bir yapı izlediği açıktır. Bu, ürün ve yazılım ekiplerinin birbirlerinden öğrenecekleri çok şey olduğu ve dokümantasyon üzerinde işbirliği içinde çalışırken çok fazla potansiyele sahip oldukları anlamına gelir.
Ürün ve Yazılım Dokümantasyon Ekipleri Birbirini Tamamlayabilir
Ürün ve yazılım dokümantasyonu arasında büyük benzerlikler vardır. Bu da şu soruyu ortaya çıkarmaktadır: Ürün ve yazılım ekipleri birlikte çalışabilir mi?
Evet, yapabilirler ve yapmalılar da!
Yazılım ekipleri teknik jargonu ve altta yatan teknolojileri anlar. Ürün ekipleri ise kullanıcıların ne gördüğünü, ne istediğini ve neye ihtiyaç duyduğunu, yani kullanıcı deneyimini anlar. Yazılım dokümantasyonu yazarları ayrıntılı teknik bilgi sağlayabilir ve ürün dokümantasyonu yazarları teknik ayrıntıları meslekten olmayan bir kitlenin tüketimi için sulandırabilir.
Meslekten olmayan bir kişinin anlayacağı bir şeyi formüle etmek için gereken üst düzey anlayışa sahip olmadan, bir şeyi meslekten olmayanların terimleriyle açıklamaya çalıştığınızı düşünün. Ürün dokümantasyonu yazılım dokümantasyonundan önce oluşturulduğunda işte böyle olur.
Kuantum mekaniği nedir? Muhtemelen aklınıza gelen ilk düşünce Schrödinger'in kedisi! Peki kuantum mekaniğinin kedilerle ne ilgisi var? Kullanıcı için önemli değil. Bir fizikçi içinse her şey demektir.
Docsie'de Yazılım Dokümantasyonu ile Başlayın, Daha İyi Ürün Dokümantasyonu ile Bitirin
Sonuç olarak, yazılım dokümantasyonunun sonraki ürün dokümantasyonu için bir şablon olarak kullanılmasının pek çok faydası vardır. Yazılım dokümantasyonu, BT personeli ve ürün dokümantasyonu yazarları için tek bir gerçek kaynak olarak hareket etmelidir. Yazıldıktan sonra, ürün dokümantasyonu yazarları, düzeltme ve kalite güvencesi için teknik rehberlikle birlikte, kullanıcı dostu bilgileri basitleştirmek ve müşterilerle paylaşmak için netlik ve anlayışa sahip olacaktır.
Basitçe, harika yazılım dokümantasyonu ile başlayarak, yazarlarınız daha da iyi ürün dokümantasyonu oluşturabilir!
Müşterilerinizin daha fazlasını yapmasına yardımcı olacak belgeler hazırlamaya başlayın. Başlangıç planımıza ](https://www.docsie.io/pricing/)(forever free!) kaydolun ve Docsie ile dokümantasyon keyfi yaşayın!