Monday, March 05, 2007

YAZILIM YAŞAM DÖNGÜSÜ BELGELEME SİSTEMİ

Not: Bu derleme-çeviri-yazımı ileride olası bir nükleer santralın kontrol odasının Türkçeleştirlmesi çalışmasına küçük bir deneysel katkı olması amacı ile yaptım.
Konuyla ilgili kişilerin eleştiri ve tavsiyelerine şiddetle ihtiyacım(ız) var. Bu yazının ne anlattığını kolaylıkla anlayabildiniz mi? Lütfen arsaral(at)yahoo.com adresine yadırgadığınız beğendiğiniz şeyleri ve önerilerinizi yazınız. Saygılar. Ali Riza SARAL

YAZILIM YAŞAM DÖNGÜSÜ BELGELEME SİSTEMİ

(ISO9000, CMM, DO178B, Mil498, ISO12207, IEEE1407 uyumlu)

Derleyen : Ali R+ SARAL

İÇİNDEKİLER
-----------------
- KULLANICI KOŞULLARI BELGESİ - USER REQUIREMENTS DOCUMENT(URD)
- YAZILIM KOŞULLARI BELGESİ - SOFTWARE REQUIREMENTS DOCUMENT(SRD)
- MİMARİ TASARIM BELGESİ - ARCHITECTURAL DESIGN DOCUMENT(ADD)
- AYRINTILI TASARIM BELGESİ - DETAILED DESIGN DOCUMENT(DDD)
- PROJE GEÇMİŞİ BELGESİ - PROJECT HISTORY DOCUMENT(PHD)
- YAZILIM KURULUM DAĞILIMI YÖNETİMİ PLANI - SOFTWARE CONFIGURATION MANAGEMENT PLAN(SCMP)
- YAZILIM PROJESİ YÖNETİM PLANI - SOFTWARE PROJECT MANAGEMENT PLAN(SPMP)
- YAZILIM KALİTE GÜVENCESİ PLANI - SOFTWARE QUALITY ASSURANCE PLAN(SQAP)
- YAZILIM DOĞRULAYIŞ VE SINAYIŞ PLANI - SOFTWARE VALIDATION AND VERIFICATION PLAN(SVVP)
- KABUL SINAVI TANIMI - ACCEPTANCE TEST SPECIFICATION(AT)
- YAZILIM KULLANICI EL-KİTABI - SOFTWARE USER MANUAL(SUM)
- YAZILIM DEVİR BELGELERİ - SOFTWARE TRANSFER DOCUMENT(STD)

--------------------------------------------------------------------------------------------------

KULLANICI KOŞULLARI BELGESİ - USER REQUIREMENTS DOCUMENT(URD)

1. Giriş
1.1 Amaç
1.2 Kapsam
1.3 Tanımlar, kısaltmalar, deyimler
1.4 Referanslar
1.5 Özet

2. Genel Açıklama
2.1 Ürüne genel bakış
2.2 Kullanıcı özellikleri
2.3 Genel Sınırlamalar
2.4 Kabuller ve bağımlılıklar
2.5 İşletimsel Ortam

3. Belirli Koşullar
3.1 Yetenek Şartları
3.2 Sınırlayıcı Şartlar

***********************************************************************************

YAZILIM KOŞULLARI BELGESİ - SOFTWARE REQUIREMENTS DOCUMENT(SRD)

1. Giriş
1.1 Amaç
1.2 Kapsam
1.3 Tanımlar, kısaltmalar, deyimler
1.4 Referanslar
1.5 Özet

2 Genel Tarif
2.1 Güncel projelerler ilişkisi
2.2 Önceki ve sonraki projelerle ilişkisi
2.3 İşlev ve amaç
2.4 Ortamsal değerlendirmeler
2.5 Diğer sistemlerle ilişkisi
2.6 Genel kısıtlamalar
2.7 Model tarifi

3 Belirli Koşullar
3.1 İşlevsel koşullar
3.2 İcra seviyesi koşulları
3.3 Arayüz koşulları
3.4 İşletimsel koşullar
3.5 Kaynak koşulları
3.6 Doğrulama koşulları
3.7 Kabul testi koşulları
3.8 Belgeleme koşulları
3.9 Güvenlik koşulları
3.10 Taşınabilirlik koşulları
3.11 Kalite koşulları
3.12 Güvenilirlik koşulları
3.13 Bakım yapılabilirlik koşulları
3.14 Güvenlik koşulları
***********************************************************************************

MİMARİ TASARIM BELGESİ - ARCHITECTURAL DESIGN DOCUMENT(ADD)

1 Giriş
1.1 Amaç
1.2 Kapsam
1.3 Tanımlar, kısaltmalar ve deyimler
1.4 Referanslar
1.5 Kısaözet

2 Ayrıştırış Tarifi
2.1 Modül ayrıştırışı
2.1.1 Modül 1 tarifi
2.1.2 Modül 2 tarifi
2.2 Eşzamanlı Süreç tarifi
2.2.1 Süreç1 tarifi
2.2.2 Süreç2 tarifi
2.3 Veri ayrıştırışı
2.3.1 Veri varlık 1 tarifi
2.3.2 Veri varlık 2 tarifi

3 Bağıntı Tarifi
3.1 Modül ler arası bağıntılar
3.2 Süreçler arası bağıntılar
3.3 Veri bağıntıları

4 Arayüz Tarifi
4.1 Modül arayüzü
4.1.1 Modül 1 tarifi
4.1.2 Modül 2 tarifi
4.2 İşlem Süreci arayüzü
2.2.1 Süreç 1 tarifi
2.2.2 Süre 2 tarifi

***********************************************************************************

AYRINTILI TASARIM BELGESİ - DETAILED DESIGN DOCUMENT(DDD)

1 Giriş
1.1 Amaç
1.2 Kapsam
1.3 Tanımlar, kısaltmalar ve deyimler
1.4 Referanslar
1.5 Kısaözet

2 Ayrıştırış Tarifi
2.1 Modül ayrıştırışı
2.1.1 Modül 1 tarifi
2.1.1.1 Modül 1 ayrıntı
2.1.2 Modül 2 tarifi
2.1.1.2 Modül 2 ayrıntı
2.2 Concurrent process tarifi
2.2.1 İşlem Süreci 1 tarifi
2.2.1.1 Süreç 1 ayrıntı l
2.2.2 İşlem Süreci 2 tarifi
2.2.1.2 Süreç 2 ayrıntı
2.3 Data decomposition
2.3.1 Veri varlığı-entity 1 tarifi
2.3.1.1 Veri varlığı 1 ayrıntı
2.3.2 Veri varlığı 2 tarifi
2.3.1.2 Veri varlığı 2 ayrıntı

3 Bağıntı Tarifi
3.1 Modüller arası bağıntılar
3.1.1 Modüller arası bağıntılar ayrıntı
3.2 İşlem süreçleri arası bağıntılar
3.2.1 2 İşlem süreçleri ayrıntı
3.3 Veri bağıntıları
3.3.1 Veri bağıntıları ayrıntı

4 Arayüz Tarifi
4.1 Modül arayüzü
4.1.1 Modül 1 tarifi
4.1.1.1 Modül 1 ayrıntı
4.1.2 Modül 2 tarifi
4.1.2.1 Modül 2 ayrıntı
4.2 İşlem süreci arayüzü
2.2.1 Süreç 1 tarifi
2.2.1.1 Süreç 1 ayrıntı
2.2.2 Süreç 2 tarifi
2.2.2.1 Süreç 2 ayrıntı


***********************************************************************************


PROJE GEÇMİŞİ BELGESİ - PROJECT HISTORY DOCUMENT(PHD)

1. Proje Tanımı

2. Proje Yönetimi
2.1 Sözleşme yaklaşımı
2.2 Proje tanımı
2.3 Kullanılan Yöntemler
2.4 Planlama

3. Yazılım Üretimi
3.1 Kestirilen ve üretilmiş gerçek toplam program kod satır sayısı
3.2 Belgeleme
3.3 Kestirilen ve gerçek çaba
3.4 Bilgisayar kaynakları
3.5 Üretkenlik faktörlerinin analizi

4. Kalite Güvencesi Gözdengeçirimi

5. Finansal Gözdengeçirim

6. Sonuçlar

7. Sistemin İşletim ve Bakım Aşamasında İcra Seviyesi
***********************************************************************************

YAZILIM KURULUM DAĞILIMI YÖNETİMİ PLANI - SOFTWARE CONFIGURATION MANAGEMENT PLAN(SCMP)
Yazılım Koşulları Aşaması - SR Phase
*******
Yapısal Tasarım Aşaması - AD Phase
********
Ayrınıtılı Tasarım Aşaması - DD Phase
********
Devir Aşaması - TR Phase
*******

1 Giriş
1.1 Amaç
1.2 Kapsam
1.3 Sözlük
1.4 Referanslar

2 Yönetim

3 Kurulum Dağılım Tanımları

4 Kurulum Dağılım Kontrolü
4.1 Program Kod controlü
4.2 Medya kontrolü
4.3 Değişiklik kontrolü

5 Kurulum Dağılım Durum Takibi

6 Yazılım Kurlum Dağılımı Yönetimi için Araçlar, Teknikler ve Yöntemler

7 Sağlayıcı Kontrolü

8 Kayıt Biriktirme ve Korunması
***********************************************************************************

YAZILIM PROJESİ YÖNETİM PLANI - SOFTWARE PROJECT MANAGEMENT PLAN(SPMP)
Yazılım Koşulları Aşaması - SR Phase
*******
Yapısal Tasarım Aşaması - AD Phase
********
Ayrınıtılı Tasarım Aşaması - DD Phase
********
Devir Aşaması - TR Phase
*******

1 Giriş
1.1 Proje kısaözeti
1.2 Proje çıktıları
1.3 SPMP’nin gelişimi
1.4 Değinilen materyaller
1.5 Tanımlar ve kısaltmalar

2 Proje Düzenlenişi
2.1 Süreç modeli
2.2 Kurluşsal yapı
2.3 Kuruluşsal sınırlar ve arayüzler
2.4 Proje sorumlulukları

3 Yönetimsel Süreç
3.1 Yönetim hedefleri ve öncelikleri
3.2 Kabuller, bağıntılar ve kısıtlar
3.3 Risk yönetimi
3.4 İzleyiş ve kontrol mekanizmaları
3.5 Eleman buluş planı

4 Teknik Süreç
4.1 Yöntemler, araçlar ve teknikler
4.2 Yazılım Belgeleyiş sistemi
4.3 Project destek işlevleri

5 İş paketleri, Zaman Cetveli ve Bütçe
5.1 İş paketleri
5.2 Bağıntılar
5.3 Kaynak koşulları
5.4 Bütçe ve kaynak ayırışı
5.5 Zaman cetveli
***********************************************************************************

YAZILIM KALİTE GÜVENCESİ PLANI - SOFTWARE QUALITY ASSURANCE PLAN(SQAP)
Yazılım Koşulları Aşaması - SR Phase
*******
Yapısal Tasarım Aşaması - AD Phase
********
Ayrınıtılı Tasarım Aşaması - DD Phase
********
Devir Aşaması - TR Phase
*******

1 Amaç

2 Değinilen Belgeler

3 Yönetim

4 Belgeleyiş Sistemi

5 Standartlar, uygulamalar, yaklaşımlar ve ölçümler-metrics
5.1 Belgeleyiş Sistemi standartları
5.2 Tasarım standartları
5.3 Program yazış standartları
5.4 Yorum notları standartları
5.5 Sınayış standartları ve uygulayışları
5.6 Seçilmiş yazılım kalite güvencesi ölçümleri
5.7 Uyumun nasıl izleneceğinin ifadesi

6 Gözden geçirişler ve sözlü dinleyişler
6.1 Amaç
6.2 Koşulların aen alt sınırı

7 Sınav

8 Sorun raporlayış ve düzeltici eylem

9 Araçlar, teknikler ve yöntemler

10 Program metni kontrolü

11 Veri ortam kontrolü

12 Sağlayıcı kontrolü

13 Kayıt toplayış, bakım ve saklanışı

14 Eğitim

15 Risk yönetimi

16 Projenin geri kalan kısmının kısa özeti
***********************************************************************************

YAZILIM DOĞRULAYIŞ VE SINAYIŞ PLANI - SOFTWARE VALIDATION AND VERIFICATION PLAN(SVVP)
Yazılım Koşulları Aşaması
*******
Mimai Tasarım Aşaması
********
Ayrıntılı Tasarım Aşaması
********
Devir Aşaması
*******

1Amaç

2 Dayanılan Belgeler

3 Tanımlar

4 Sınama kısa özeti
4.1 Örgütleniş
4.2 Ana program
4.3 Kaynaklar özeti
4.4 Sorumluluklar
4.5 Araçlar, teknikler ve yöntemler

5 Sınama İdari İşlemleri
5.1 Gariplik raporlayış ve çözüş
5.2 Görev tekrar politikası
5.3 Sapma politikası
5.4 Kontrol işlemleri
5.5 Standartlar, uygulamalar ve yaklaşımlar

6 Sınama faaliyetleri

7 Yazılım Sınama Raporlayışı
7.1 İz sürülebilirlik matris kalıbı
7.2 Biçimsel ispatlar
7.3 Gözden geçirişler

***********************************************************************************

KABUL SINAVI TANIMI - ACCEPTANCE TEST SPECIFICATION(AT)
SVVP/AT
*******
Sistem Sınav Belirleyicisi
********************
Tümleşik Sınav Belirleyicisi
***********************
Birimsel Sınav Belirleyicisi
***********************

1 Sınav Planı
1.1 Giriş
1.2 Sınav unsurları
1.3 Sınanıcak özellikler
1.4 Sınanmayacak özellikler
1.5 Yaklaşım
1.6 Unsur geçiş/kalış koşulu
1.7 Askıya alış koşulu ve devam ediş koşulları
1.8 Sınav çıktıları
1.9 Sınayış görevleri
1.10 Ortamsal ihtiyaçlar
1.11 Sorumluluklar
1.12 Eleman durumu ve eğitim ihtiyaçları
1.13 Zamanlayış
1.14 Riskler ve umulmadık durumlar
1.15 Onaylar

2 Sınav Tasarımları (her test tasarımı başına...)
2.n.1 Sınav tasarım belirleyicisi
2.n.2 Test edilecek özellikler
2.n.3 Yaklaşım şartları
2.n.4 Sınanacak durumları belirlenişi
2.n.5 Özellik geçiş/kalış koşulu

3 Sınanıcak Durum Tarifleri(her test durumu başına...)
3.n.1 Sınanıcak durum belirleyicisi
3.n.2 Sınav unsurları
3.n.3 Giriş belirleyicileri
3.n.4 Çıkış belirleyicileri
3.n.5 Ortamsal ihtiyaçlar
3.n.6 Özel süreç koşulları
3.n.7 Durumlar arası bağımlılıklar

4 Sınav süreci(her sınav durumu başına...)
4.n.1 Sınav rapor belirleyicisi
4.n.2 Amaç
4.n.3 Özel şartlar
4.n.4 İşlem süreci adımları

5 Sınav RaporlarıTest Reports(her sınav süreci uygulaması başına bir tane...)
5.n.1 Sınav rapor belirleyicisi
5.n.2 Tarif
5.n.3 Faaliyet ve olay girişleri
***********************************************************************************

YAZILIM KULLANICI EL-KİTABI - SOFTWARE USER MANUAL(SUM)

1 Giriş
1.1 Niyetlenilen okuyucu kitlesi
1.2 Uygulanabilirlik ifadesi
1.3 Amaç
1.4 Bu belgeyi nasıl kullanmalı
1.5 İlgili belgeler
1.6 Yaklaşımlar
1.7 Sorun bildirme komutları

2 Kısa özet bölümü
(Bu bölüm kullanıcıya yazılımın hangi bölümlerinin ihtiyaç duyulan
yetenekleri sağladığına dair genel bir anlayış verir.)

3 Komutlar bölümü
(Her komut için aşağıdakileri sağlar…
(a) İşlevsel tarif
(b) Dikkat çekilen noktalar ve uyarılar
(c) İşlemler, aşağıdakiler dahil:
- Kurulum ve başlangıç
- Giriş işlemleri
- Beklenilen sonuçlar
(d) Olabilecek hatalar ve muhtemel nedenler)

4 Başvuru bölümü
(Her işlemi tanımla, aşağıdakiler dahil olmak üzere :
(a) İşlevsel tarif
(b) Dikkat çekilen noktalar ve uyarılar
(c) Biçimsel tarif, aşağıdakilerden yeri gelenler dahil olmak üzere:
- gerekli değişkenler
- isteğe bağlı değişkenler
- yoktan geçerli seçenekler
- sıra ve dilbilgisi
(d) Örnekler
(e) Olabilecek hatalar ve muhtemel nedenler
(f) Diğer işlemlere kestirme değinmeler)
Ek A Hata mesajları ve kurtarıcı işlemler
Ek B Sözlük
Ek C İçindekiler

***********************************************************************************

YAZILIM DEVİR BELGELERİ - SOFTWARE TRANSFER DOCUMENT(STD)

1 Giriş
1.1 Amaç
1.2 Kapsam
1.3 Tanımlar, Kısaltmalar, Deyimler
1.4 Referanslar

2 Kurulum İşlemleri

3 Uygulama İnşa İşlemleri

4 Kurulum Yapısı Unsurları Listesi

5 Kabul Sınama Rapor Özeti

6 Yazılım Sorun Raporları

7 Yazılım Değişiklik İstekleri

8 Yazılım Değişiklik Raporları
***********************************************************************************
***********************************************************************************
***********************************************************************************

Hayırlı olsun...