Proje Dökümantasyon Süreci¶

ISO/IEC 15504 SPICE | SUP.7 Documentation gereksinimlerinin karşılanması beklenmektedir.

İlgili süreç Proje Versiyonlama Süreci ile birlikte uygulanır - döküman versiyonları proje versiyonları ile senkronize edilir.

SPICE SUP.7 Pratik Karşılama¶

Temel Pratikler ve Karşılama Yöntemleri¶

BP	Pratik	GitLab/Araç Karşılama	Doküman
BP1	Dokümantasyon yönetim stratejisi geliştir	Bu süreç dökümanı	Proje Dökümantasyon Süreci
BP2	Standartlar oluştur	Şablon repository + checklist	Şablon yönetimi
BP3	Doküman gereksinimlerini belirle	SPICE süreç tablosu	SPICE dokümantasyon matrisi
BP4	Üretılecek dokümanları tanımla	Jira Süreci task'ları + proje yapısı	Proje dizin yapısı
BP5	Dokümanları geliştir	GitLab branch + merge request	Dökümantasyon yaşam döngüsü
BP6	Dokümanları kontrol et	Peer review + kalite kontrolü	Gözden geçirme süreci
BP7	Dokümanları yayınla	Main branch merge + tag	Yayınlama aşaması
BP8	Bakım yap	Versiyon kontrolü + güncellemeler	Arşivleme ve saklama

Dökümantasyon Stratejisi¶

Amaç ve Hedefler¶

Proje dökümantasyonları, ISO/IEC 15504 SPICE standartlarına uygun olarak yerel GitLab sunucumuzda merkezi bir şekilde yönetilir. Bu süreç, proje bilgilerinin: - Erişilebilir ve güncel tutulmasını - Versiyon kontrolü altında izlenmesini - Güvenli bir şekilde saklanmasını - Proje ekipleri arasında etkin paylaşımını - SPICE süreç gereksinimlerinin karşılanmasını sağlar.

Temel İlkeler¶

Merkezi Yönetim: Tüm proje dökümantasyonları GitLab'da MkDocs formatında saklanır (BP1)
Versiyon Kontrolü: Her değişiklik izlenir ve kayıt altına alınır (BP8)
Erişim Kontrolü: Rol tabanlı erişim yetkilendirmesi (BP7)
Standartlaşma: Belirlenmiş şablonlar ve formatlar kullanılır (BP2)
İzlenebilirlik: Dökümantasyon değişiklikleri tam olarak izlenebilir (BP6)

Dökümantasyon Türleri ve Sınıflandırması¶

SPICE Süreç Dokümantasyonu¶

SPICE Süreci	Gerekli Dokümantasyon	Şablon	Sorumluluk
MAN.3	Proje Yönetimi Planı	✅ Süreç + Şablon	Proje Yöneticisi
MAN.5	Risk Yönetimi Planı	✅ Süreç	Proje Yöneticisi
ENG.1	Gereksinim Toplama Raporu	✅ Süreç + Şablonlar	Sistem Analisti
ENG.4	Yazılım Gereksinim Analizi	✅ Süreç + Şablon	Yazılım Analisti
ENG.5	Tasarım Dokümantasyonu	✅ Şablonlar - Yazılım, Arayüz, Fiziksel Mimari, Veri Modeli	Tasarım Uzmanı
ENG.6	Kodlama ve Geliştirme Dökümanları	✅ Şablon	Geliştirici
ENG.7	Entegrasyon Dokümantasyonu	✅ Şablon	Entegrasyon Uzmanı
ENG.8	Test Dokümantasyonu	✅ Süreç + Şablon	Test Uzmanı
SPL.2	Sürüm Yayınlama Planı	✅ Süreç + Şablon	Sürüm Yöneticisi
SUP.1	Kalite Güvence Raporları	✅ Süreç + Şablon	Kalite Uzmanı
SUP.2	Doğrulama Dokümantasyonu	✅ Süreç + Şablon	Doğrulama Uzmanı
SUP.7	Dökümantasyon Yönetimi	✅ Süreç + Şablon	Döküman Yöneticisi
SUP.8	Konfigürasyon Yönetimi	✅ Süreç + Şablon	Konfig. Yöneticisi
SUP.9	Problem Çözme Raporları	✅ Şablon	Problem Çözme Uzmanı
SUP.10	Değişiklik İsteği Dokümantasyonu	✅ Süreç + Şablon	Değişiklik Yöneticisi

Dokümantasyon Öncelik Seviyeleri¶

Kritik (P1): SPICE zorunlu dokümantasyonu
Yüksek (P2): Proje yönetimi ve kalite dokümantasyonu
Orta (P3): Teknik detay ve kullanıcı dokümantasyonu
Düşük (P4): Yardımcı ve referans dokümantasyonu

MkDocs Tabanlı Dökümantasyon Yönetimi¶

GitLab, proje dökümantasyonlarının merkezi olarak yönetilmesi için kullanılır. Her proje için ayrı bir repository oluşturulur ve bu repository içerisinde dökümantasyon dosyaları MkDocs formatında docs/ klasörü altında saklanır.

Proje Döküman Yapısı¶

Her proje için aşağıdaki dizin yapısı GitLab repository'sinde MkDocs formatında oluşturulur:

[Proje Adı]/
├── mkdocs.yml (MkDocs yapılandırma dosyası)
├── docs/
│   ├── index.md (Proje genel bilgileri - Ana Sayfa)
│   ├── proje-yonetim-plani.md
│   ├── proje-takvimi.md (Proje zaman çizelgesi)
│   ├── Formlar/
│   │   ├── index.md
│   │   ├── proje-fizibilite-formu.md
│   │   ├── risk-yanit-formu.md
│   │   ├── musteri-memnuniyet-anketi.md
│   │   ├── proje-kapanis-raporu.md
│   ├── Gereksinimler/
│   │   ├── index.md
│   │   ├── gereksinim-dokumani.md
│   │   ├── gereksinim-tanimlama.md
│   │   ├── gereksinim-ekip-dogrulama.md
│   │   ├── gereksinim-musteri-dogrulama.md
│   │   ├── gereksinim-onay.md
│   │   └── gereksinim-teslim.md
│   ├── Planlar/
│   │   ├── index.md
│   │   ├── test-plani.md
│   │   ├── denetim-plani.md
│   │   ├── konfigurasyon-yonetim-plani.md
│   ├── Tasarim/
│   │   ├── index.md
│   │   ├── yazilim-tasarim-dokumani.md
│   │   ├── arayuz-tasarim-dokumani.md
│   │   ├── fiziksel-mimari-tasarim.md
│   │   ├── fiziksel-veri-modeli.md
│   │   └── tasarim-gozden-gecirme.md
│   ├── Test/
│   │   ├── index.md
│   │   ├── test-plani.md
│   │   ├── test-senaryolari.md
│   │   ├── test-sonuclari.md
│   │   └── test-raporlari.md
│   ├── Risk-Yonetimi/
│   │   ├── index.md
│   │   ├── risk-yonetim-plani.md
│   │   ├── risk-yanit-formu.md
│   │   ├── risk-degerlendirme-raporu.md
│   │   └── risk-izleme-raporu.md
│   ├── Raporlar/
│   │   ├── index.md
│   │   ├── kalite-guvence-raporlari.md
│   │   ├── problem-cozme-raporlari.md
│   │   ├── dogrulama-raporlari.md
│   │   ├── proje-durum-raporlari.md
│   │   ├── surum-yayinlama-raporlari.md
│   │   ├── surec-performans-raporlari.md
│   │   └── denetim-raporlari.md
│   ├── Dokumantasyon/
│   │   ├── index.md
│   │   ├── teknik-kilavuz.md
│   │   ├── kullanici-kilavuzu.md
│   │   ├── api-dokumantasyonu.md
│   │   ├── yonetici-kilavuzu.md
│   │   └── hizli-baslangic-kilavuzu.md
│   └── Arsiv/
│       ├── index.md
│       ├── Eski-Versiyonlar/
│       └── Tamamlanan-Dokumantasyon/

MkDocs Yapılandırma Örneği (mkdocs.yml)¶

Her proje repository'sinde aşağıdaki gibi bir mkdocs.yml dosyası bulunur:

site_name: "[Proje Adı] - Dokümantasyon"
site_description: "ISO/IEC 15504 SPICE uyumlu proje dokümantasyonu"
site_author: "trex Dijital Akıllı Üretim Sistemleri A.Ş."

theme:
  name: material
  language: tr
  palette:
    - scheme: default
      primary: green
      accent: green

nav:
  - Ana Sayfa: index.md
  - Proje Yönetimi:
    - "Proje Yönetim Planı": proje-yonetim-plani.md
    - "Proje Takvimi": proje-takvimi.md
  - Formlar:
    - Genel Bakış: "Formlar/index.md"
    - "Proje Fizibilite Formu": "Formlar/proje-fizibilite-formu.md"
    - "Risk Yanıt Formu": "Formlar/risk-yanit-formu.md"
    # ... diğer formlar
  - Gereksinimler:
    - Genel Bakış: "Gereksinimler/index.md"
    - "Gereksinim Dokümanı": "Gereksinimler/gereksinim-dokumani.md"
    # ... diğer gereksinim dokümanları
  - Planlar:
    - Genel Bakış: "Planlar/index.md"
    - "Test Planı": "Planlar/test-plani.md"
    # ... diğer planlar
  - Tasarım:
    - Genel Bakış: "Tasarim/index.md"
    - "Yazılım Tasarım Dokümanı": "Tasarim/yazilim-tasarim-dokumani.md"
    # ... diğer tasarım dokümanları
  - Test:
    - Genel Bakış: "Test/index.md"
    - "Test Planı": "Test/test-plani.md"
    # ... diğer test dokümanları
  - Risk Yönetimi:
    - Genel Bakış: "Risk-Yonetimi/index.md"
    - "Risk Yönetim Planı": "Risk-Yonetimi/risk-yonetim-plani.md"
    # ... diğer risk dokümanları
  - Raporlar:
    - Genel Bakış: "Raporlar/index.md"
    - "Kalite Güvence Raporları": "Raporlar/kalite-guvence-raporlari.md"
    # ... diğer raporlar
  - Dokümantasyon:
    - Genel Bakış: "Dokumantasyon/index.md"
    - "Teknik Kılavuz": "Dokumantasyon/teknik-kilavuz.md"
    # ... diğer dokümantasyon
  - Arşiv:
    - Genel Bakış: "Arsiv/index.md"

plugins:
  - search:
      lang: tr

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - attr_list
  - toc:
      permalink: true
  - tables

extra:
  social:
    - icon: fontawesome/solid/globe
      link: https://trex.com.tr
    - icon: fontawesome/solid/envelope
      link: mailto:info@trex.com.tr

copyright: Copyright &copy; 2025 trex Dijital Akıllı Üretim Sistemleri A.Ş.

MkDocs Avantajları¶

Statik Site Üretimi: HTML olarak derlenebilir
Responsive Tasarım: Mobil uyumlu görünüm
Arama Özelliği: İçerik içinde arama
Tema Desteği: Material Design tema
Markdown Desteği: Kolay yazım formatı
Çok Dilli Destek: Türkçe karakter desteği
PDF Export: Dokümantasyonu PDF olarak çıktı alma
CI/CD Entegrasyonu: Otomatik build ve deploy

Dökümantasyon Yaşam Döngüsü¶

1. Oluşturma Aşaması (BP4, BP5)¶

Şablon Seçimi: İlgili SPICE süreci için süreç ve şablon belirlenir (BP2)
Proje Takip: Jira Süreci standartlarına uygun task oluşturulur (BP4)
Branch Oluşturma: Task branchı oluşturulur (task/[Proje Kodu]-[Task Numarası] i.e. task/ADPN-03)
MkDocs Dosya Oluşturma: docs/ klasörü altında .md dosyası oluşturulur (BP5)
İçerik Geliştirme: Şablona uygun içerik hazırlanır (BP5)
Ön Gözden Geçirme: Yazan kişi tarafından kontrol edilir

2. Gözden Geçirme Aşaması (BP6)¶

Merge Request: Dokümantasyon için MR oluşturulur
Peer Review: En az 1 kişi tarafından gözden geçirilir (BP6)
Teknik Gözden Geçirme: İlgili uzman tarafından kontrol edilir (BP6)
Kalite Kontrolü: Kalite uzmanı tarafından SPICE uyumluluğu kontrol edilir (BP6)

3. Onay Aşaması (BP7)¶

Proje Yöneticisi Onayı: Proje kapsamı açısından onaylanır
Teknik Lider Onayı: Teknik doğruluk açısından onaylanır
Son Onay: Gerekirse üst yönetim onayı alınır
Merge İşlemi: Ana dal'a (main/master) merge edilir (BP7)

4. Yayınlama Aşaması (BP7, BP8)¶

Tag Oluşturma: Versiyon etiketi oluşturulur (BP7)
MkDocs Build: mkdocs build komutu ile statik site oluşturulur (BP7)
Deployment: GitLab Pages veya web sunucusuna deploy edilir (BP7)
Dağıtım: İlgili paydaşlara bildirim yapılır (BP7)
Arşivleme: Eski versiyon arşivlenir (BP8)

Versiyon Kontrolü ve Onay Süreçleri¶

Versiyon Numaralandırma¶

Major.Minor.Patch formatı kullanılır (örn: 1.2.3)
Proje Versiyonu ile Senkronizasyon: Proje Versiyonlama Süreci ile uyumlu versiyon takibi
Major: Büyük değişiklikler, yeniden yapılandırma
Minor: Yeni bölümler, önemli güncellemeler
Patch: Küçük düzeltmeler, yazım hataları

Güvenlik Önlemleri¶

VPN Erişimi: Dış ağdan erişim için VPN gerekli
Audit Log: Tüm erişim ve değişiklikler loglanır
Backup Encryption: Yedekler şifreli olarak saklanır

Şablon Yönetimi¶

Şablon Deposu¶

Tüm şablonlar merkezi şablon repository'sinde saklanır

Şablon Kategorileri¶

SPICE Süreç Şablonları
Proje Yönetimi Şablonları
Teknik Dokümantasyon Şablonları
Toplantı ve Form Şablonları
Rapor Şablonları

Şablon Güncelleme Süreci (BP2, BP8)¶

Şablon değişiklik talebi (JIRA SPICE projesi altında task)
Şablon komitesi değerlendirmesi (BP2)
Geliştirme ve test
Onay ve yayınlama (BP7)
Proje repository'lerinde güncelleme (BP8)

Kalite Kontrol ve Gözden Geçirme¶

Kalite Kriterleri¶

SPICE Uyumluluğu: İlgili SPICE süreç gereksinimlerine uygunluk
Şablon Uyumluluğu: Standart şablonlara uygunluk
İçerik Kalitesi: Doğruluk, eksiksizlik, anlaşılırlık

Gözden Geçirme Checklist (BP6)¶

Erişim Kontrolü ve Güvenlik¶

Rol Tabanlı Erişim Kontrolü¶

Rol	Okuma	Yazma	Onay	Silme
Proje Yöneticisi	✅	✅	✅	✅
Teknik Lider	✅	✅	✅	❌
Geliştirici	✅	✅	❌	❌
Müşteri	✅	❌	❌	❌
Dış Paydaş	Sınırlı	❌	❌	❌

Güvenlik Kriterleri¶

Erişim Loglama: Tüm döküman erişimleri loglanır
İnternet Güvenliği: VPN üzerinden güvenli erişim
Yetkilendirme: Minimum yetki prensibi uygulanır
Veri Şifreleme: Hassas dokümanlar şifreli saklanır

Arşivleme ve Saklama¶

Arşivleme Politikası (BP8)¶

Aktif Dökümanlar: Proje süresince erişilebilir
Tamamlanan Dökümanlar: Arşiv klasörüne taşınır
Eski Versiyonlar: 2 yıl süreyle saklanır
Proje Kapanışı: Tüm dokümanlar merkezi arşive aktarılır

Saklama Süreleri¶

Doküman Türü	Aktif Saklama	Arşiv Saklama	İmha
SPICE Süreç Dokümanları	Proje süresince	5 yıl	Sonrasında
Teknik Dokümantasyon	Proje süresince	3 yıl	Sonrasında
Toplantı Tutanakları	1 yıl	2 yıl	Sonrasında
Form ve Anketler	6 ay	1 yıl	Sonrasında

Backup Stratejisi¶

Günlük Yedekleme: GitLab otomatik backup
Haftalık Arşiv: Eksternal storage'a kopyalama
Aylık Test: Yedekleme geri yükleme testi
Disaster Recovery: 24 saat içinde tam geri yükleme
MkDocs Site Backup: Build edilmiş HTML dosyaları da yedeklenir

Eğitim ve Farkındalık¶

Eğitim Programı¶

Hedef Kitle	Eğitim İçeriği	Süre	Sıklık
Yeni Başlayanlar	GitLab + MkDocs + SPICE dokümantasyon	4 saat	İlk hafta
Proje Ekibi	Markdown + şablon kullanımı + süreçler	2 saat	Proje başında
Yöneticiler	Onay süreçleri + raporlama	1 saat	6 ayda bir
Tüm Personel	Güvenlik + erişim kontrolü	30 dk	Yılda bir

Farkındalık Aktiviteleri¶

Dokümantasyon Günü: Aylık bilgilendirme toplantıları
Best Practices Paylaşımı: Başarılı örnek dokümanlar
Feedback Toplama: Süreç iyileştirme önerileri
Ödül Sistemi: En iyi dokümantasyon örnekleri ödüllendirilir

Performans Göstergeleri¶

Dokümantasyon Tamamlanma Oranı: >95%
Kalite Puanı: >4.0/5.0
Güncellik Oranı: >90%
Kullanıcı Memnuniyeti: >4.0/5.0

Not: Bu dokümandaki tüm bilgiler ISO/IEC 15504 SPICE | SUP.7 Documentation gereksinimlerine uygun olarak hazırlanmış ve proje dosyasında arşivlenmiştir.

Bu süreç dökümanı, tüm proje ekiplerinin GitLab tabanlı MkDocs dökümantasyon yönetimi konusunda aynı standartları uygulamasını sağlamak amacıyla hazırlanmıştır.