Program Dokümantasyonu
Kullanıcılarına bir yazılımı veya programı tanımlayan her türlü yazılı metin, resim veya video denir program or software document. Kullanıcı, bir programcı, sistem analisti ve yöneticiden son kullanıcıya kadar herkes olabilir. Çeşitli geliştirme aşamalarında, farklı kullanıcılar için birden çok belge oluşturulabilir. Aslında,software documentation genel yazılım geliştirme sürecinde kritik bir süreçtir.
Modüler programlamada dokümantasyon daha da önemli hale gelir çünkü yazılımın farklı modülleri farklı ekipler tarafından geliştirilir. Geliştirme ekibinden başka biri bir modülü anlamak istiyorsa veya buna ihtiyaç duyuyorsa, iyi ve ayrıntılı dokümantasyon görevi kolaylaştıracaktır.
Bunlar, belgeleri oluşturmak için bazı yönergelerdir -
Dokümantasyon okuyucunun bakış açısından olmalıdır
Belge net olmalıdır
Tekrar olmamalı
Endüstri standartları kullanılmalı
Belgeler her zaman güncellenmelidir
Güncelliğini yitirmiş herhangi bir belge, aşamalı olarak sona erme zamanı kaydedildikten sonra aşamalı olarak kaldırılmalıdır
Dokümantasyonun Avantajları
Bunlar program dokümantasyonu sağlamanın avantajlarından bazılarıdır -
Bir yazılımın veya programın tüm parçalarını takip eder
Bakım daha kolaydır
Geliştirici dışındaki programcılar, yazılımın tüm yönlerini anlayabilir
Yazılımın genel kalitesini iyileştirir
Kullanıcı eğitimine yardımcı olur
İnsanların sistemden aniden ayrılması durumunda bilgi merkeziyetsizliğini, maliyetleri ve çabayı azaltır
Örnek Belgeler
Bir yazılım, kendisiyle ilişkili birçok türde belgeye sahip olabilir. Önemli olanlardan bazıları şunlardır:
User manual - Yazılımın farklı özelliklerini kullanmak için son kullanıcıların talimatları ve prosedürleri açıklar.
Operational manual - Gerçekleştirilen tüm işlemleri ve bunların birbirine bağımlılıklarını listeler ve açıklar.
Design Document- Yazılıma genel bir bakış sağlar ve tasarım öğelerini ayrıntılı olarak açıklar. Gibi ayrıntıları belgelerdata flow diagrams, entity relationship diagrams, vb.
Requirements Document- Sistemin tüm gereksinimlerinin bir listesi ile gereksinimlerin uygulanabilirliğinin bir analizini içerir. Kullanıcı vakalarına, gerçek hayat senaryolarına vb. Sahip olabilir.
Technical Documentation - Algoritmalar, akış şemaları, program kodları, işlevsel modüller vb. Gibi gerçek programlama bileşenlerinin bir dokümantasyonudur.
Testing Document - Test planını, test senaryolarını, doğrulama planını, doğrulama planını, test sonuçlarını vb. Kaydeder. Test, yazılım geliştirmenin yoğun dokümantasyon gerektiren bir aşamasıdır.
List of Known Bugs- Her yazılımda, çok geç keşfedildikleri veya zararsız oldukları veya düzeltilmesi gerekenden daha fazla çaba ve zaman alacağı için kaldırılamayan hatalar veya hatalar vardır. Bu hatalar, daha sonraki bir tarihte kaldırılabilmeleri için program belgelerinde listelenmiştir. Ayrıca hata etkinleştirilirse kullanıcılara, uygulayıcılara ve bakım personeline yardımcı olurlar.