YAZILIM GELİŞTİRME YAŞAM DÖNGÜSÜNDE DOKÜMANTASYON EĞİTİMİ

Yazılım belgelerini yaşayan ve kullanılan hale getirin

Gereksinim belgeleri, mimari karar kaydı, API dokümantasyonu, test planı, kullanıcı kılavuzu ve docs-as-code yaklaşımı iki günde uygulamalı işlenir

Yazılım yaşam döngüsünde dokümantasyon eğitimi; gereksinim belirtimi, ADR ve C4, OpenAPI, test planı, README, kullanıcı kılavuzu, sürüm notları ve docs-as-code yaklaşımını kapsar.

2 gün Temel Seviye Online / Yüz Yüze / Hibrit Sertifikalı

Eğitim Hakkında

Yazılım geliştirme yaşam döngüsünde dokümantasyon pratiği

Eğitim, yazılım yaşam döngüsünün her aşamasında hangi dokümanın neden gerektiğini ve nasıl yazılacağını anlatır. Gereksinim belirtimi ve kullanıcı hikayeleri, mimari karar kaydı (ADR) ve C4 diyagramları, OpenAPI ile API dokümantasyonu, test planı ve test senaryosu şablonları, README ve kullanıcı kılavuzu, sürüm notları, Markdown ve docs-as-code yaklaşımı ile belge bakımı uygulamalı işlenir.

Süre ve Format

2 Gün. Her gün dört modül; 1. gün Gereksinim, Tasarım ve API Belgeleri; 2. gün Test, Kullanıcı ve Bakım Belgeleri.

Seviye

Temel Seviye — SDLC aşamalarında dokümantasyon: gereksinim, tasarım, API, test, kullanım ve bakım belgeleri

Öğrenme Metodu

Katılımcılar örnek bir projenin gereksinimden sürüm notuna kadar belge setini hazırlar ve Git depoda sürümler.

Neden Bu Eğitim?

📚Doğru Belge Doğru Zamanda

Her SDLC aşamasında hangi belgenin değer kattığını ayırt edersiniz.

🔄Docs-as-Code

Belgeleri kodla birlikte Git'te sürümleyip güncel tutarsınız.

🤝Ekip İletişimi

Anlaşılır ve kısa belgelerle devir ve onboarding süresini kısaltırsınız.

Anahtar Konular

yazılım dokümantasyonusdlc dokümantasyonopenapi dokümantasyonadr mimari karar kaydıc4 modeligereksinim belgesitest planıdocs as codereadme yazımıteknik yazarlık
“Yazılmamış bilgi, ekipten ayrılan kişiyle birlikte gider.”

Ön Koşullar

Eğitimden verim almak için faydalı olacak bilgi ve ortam gereksinimleri

1
Yazılım süreci

SDLC, çevik veya şelale modeli hakkında temel bilgi yeterlidir.

2
Markdown ve Git

Temel Markdown yazımı ve Git kullanımı faydalıdır.

3
Proje deneyimi

Bir yazılım projesinde görev almış olmak yararlıdır.

4
Ortam

VS Code, Git ve tarayıcı kurulu bir bilgisayar yeterlidir.

Eğitim İçeriği

Programın gün gün akışı aşağıdadır. Bir güne tıklayarak o günün modüllerini ve içeriklerini görebilirsiniz.

Günün hedefiKatılımcı gereksinim, mimari ve API belgelerini yazar.
Modül 1
Gereksinim Belgeleri
  • Fonksiyonel ve fonksiyonel olmayan gereksinimler
  • Kullanıcı hikayesi formatı ve kabul kriterleri (Given/When/Then)
  • SRS ve ürün gereksinim belgesi (PRD) farkı
  • Kapsam, varsayım ve kısıtlar
  • İzlenebilirlik matrisi
  • Gereksinim değişiklik yönetimi
Modül 2
Mimari ve Tasarım
  • Mimari karar kaydı (ADR) şablonu
  • C4 modeli: bağlam, konteyner, bileşen
  • UML sınıf ve sıra diyagramları
  • Mermaid ve PlantUML ile diyagramı kod olarak yazma
  • Veri sözlüğü ve ER diyagramı
  • Tasarım incelemesi (design review)
Modül 3
API Dokümantasyonu
  • OpenAPI 3 ile sözleşme yazımı
  • Swagger UI ve Redoc yayınlama
  • Örnek istek/yanıt ve hata kodları
  • Kod yorumlarından doküman: Javadoc, PHPDoc, JSDoc
  • Postman koleksiyonu dokümantasyonu
  • API değişiklik günlüğü ve sürümleme
Modül 4
Teknik Yazım
  • Okuyucu analizi ve amaç belirleme
  • Kısa, net ve tutarlı yazım
  • Başlık yapısı ve içindekiler
  • Terim sözlüğü
  • Şablon ve stil rehberi
  • Gözden geçirme ve geri bildirim
Günün hedefiKatılımcı test, kullanım ve bakım belgelerini hazırlar ve belge bakımını kurar.
Modül 1
Test Belgeleri
  • Test stratejisi ve test planı
  • Test senaryosu ve test vakası şablonu
  • Hata raporu: yeniden üretme adımları
  • Test sonuç raporu
  • Kabul testi belgesi
  • Gereksinim-test izlenebilirliği
Modül 2
Kullanıcı Belgeleri
  • README: kurulum, kullanım, katkı
  • Kullanıcı kılavuzu ve hızlı başlangıç
  • SSS ve sorun giderme
  • Ekran görüntüsü ve kısa video
  • Çok dilli belge yönetimi
  • Erişilebilir belge yazımı
Modül 3
İşletme ve Bakım
  • Sürüm notları ve CHANGELOG
  • Operasyon el kitabı (runbook)
  • Olay sonrası inceleme (postmortem)
  • Onboarding rehberi
  • Devir teslim belgesi
  • Yedekleme ve felaket kurtarma planı belgesi
Modül 4
Docs-as-Code
  • Markdown ve Git ile belge sürümleme
  • MkDocs / Docusaurus ile yayın
  • CI'da bağlantı ve stil denetimi
  • Belge sahipliği ve gözden geçirme döngüsü
  • Belge kalitesi metrikleri
  • Güncel tutma alışkanlığı

Eğitim Kazanımları

Program sonunda katılımcılar:

✅
Gereksinim Yazımı

Kullanıcı hikayesi ve kabul kriteriyle net gereksinim yazabilirsiniz.

✅
Mimari Kayıt

ADR ve C4 diyagramlarıyla mimari kararları belgeleyebilirsiniz.

✅
API Belgesi

OpenAPI ile API sözleşmesi yazıp yayınlayabilirsiniz.

✅
Diyagram Kodu

Mermaid veya PlantUML ile diyagramları sürümlenebilir hale getirebilirsiniz.

✅
Test Belgesi

Test planı ve vaka şablonlarını hazırlayabilirsiniz.

✅
Kullanıcı Kılavuzu

README ve kullanıcı kılavuzunu okuyucu odaklı yazabilirsiniz.

✅
Sürüm Notu

CHANGELOG ve sürüm notlarını düzenli tutabilirsiniz.

✅
Belge Bakımı

Docs-as-code ile belgeleri Git'te güncel tutabilirsiniz.

Kimler İçin Uygundur?

  • Yazılımcılar
  • analistler
  • proje yöneticileri
  • test uzmanları
  • teknik yazarlar için uygundur

Sıkça Sorulan Sorular

Bu eğitim kimler için uygundur?
Yazılımcılar, analistler, proje yöneticileri, test uzmanları ve teknik yazarlar için uygundur.
Kod yazmayan roller için uygun mu?
Evet; analist, test uzmanı ve proje yöneticileri için gereksinim, test ve kullanıcı belgesi bölümleri doğrudan uygulanabilir.
Çevik ekiplerde fazla belge yükü olmaz mı?
Eğitim 'yeterli ve güncel belge' ilkesini işler; hangi belgenin gerekli olduğuna karar ölçütleri verilir.
Hangi araçlar kullanılır?
Markdown, Git, Mermaid, Swagger UI ve MkDocs; hepsi ücretsiz araçlardır.
Sertifika verilir mi?
Digital Vizyon Akademi Katılım ve Başarı Sertifikası verilir.

Sertifikalandırma

Bu eğitim Digital Vizyon Akademi Başarı Sertifikası ile tamamlanır.

Eğitim başında “Ön Test”, bitiminde “Son Test” uygulanarak gelişim ölçümlenir. Değerlendirme formunu dolduran katılımcılar sertifikalarını alır. Sertifikanızın geçerliliğini Sertifika Sorgulama sayfasından doğrulayabilirsiniz.

Örnek Sertifika d Digital Vizyon AKADEMİ KATILIM SERTİFİKASI Bu sertifika [Katılımcı Adı Soyadı] adlı katılımcının aşağıdaki eğitim programını başarıyla tamamladığını belgeler. Yazılım Geliştirme Yaşam Döngüsünde Dokümantasyon Eğitimi Sertifika Kodu DV-2026XX00 Tarih 27.10.2026 Yetkili İmza DV AKADEMİ

Eğitim Bilgileri

Süre2 gün
SeviyeTemel Seviye
FormatOnline / Yüz Yüze / Hibrit
Sertifika✓ Var
Hemen Bilgi Al
İlgili Eğitimler

Bu Eğitimle Birlikte Tercih Edilenler

Programlama Temelleri ve Yaşam DöngüsüData Manipulation & Debugging Eğitimi
Yazılım Geliştirme Eğitimleri

Data Manipulation & Debugging Eğitimi

2 günOrtaOnline / Yüz Yüze / Hibrit

C# veri işleme ve hata ayıklama eğitimi: koleksiyonlar, LINQ, System.Text.Json, XML, Entity Framework Core ve Visual Studio ile veri hatası ayıklama.

Detayları Gör →
Programlama Temelleri ve Yaşam DöngüsüDebugging Concepts Eğitimi
Yazılım Geliştirme Eğitimleri

Debugging Concepts Eğitimi

2 günTemelOnline / Yüz Yüze / Hibrit

Hata türleri, breakpoint, çağrı yığını, loglama ve git bisect ile sistematik hata ayıklamayı öğrenin. Uygulamalı Debugging Concepts eğitimi Digital Vizyon Akade

Detayları Gör →
Programlama Temelleri ve Yaşam DöngüsüDebugging Environments & Dumps Eğitimi
Yazılım Geliştirme Eğitimleri

Debugging Environments & Dumps Eğitimi

2 günOrtaOnline / Yüz Yüze / Hibrit

Uzak ve konteyner debug, ProcDump, WinDbg, Visual Studio dump analizi, sembol sunucusu ve Linux core dump konularını uygulamalı öğrenin. Digital Vizyon Akademi.

Detayları Gör →
Programlama Temelleri ve Yaşam DöngüsüDebugging Tools & Best Practices Eğitimi
Yazılım Geliştirme Eğitimleri

Debugging Tools & Best Practices Eğitimi

2 günOrtaOnline / Yüz Yüze / Hibrit

gdb, Visual Studio, strace, Wireshark ve Chrome DevTools ile hata ayıklama; loglama, assert ve ekip pratikleri. Uygulamalı eğitim Digital Vizyon Akademi'de.

Detayları Gör →
Programlama Temelleri ve Yaşam DöngüsüDebugging Tools Eğitimi
Yazılım Geliştirme Eğitimleri

Debugging Tools Eğitimi

2 günTemelOnline / Yüz Yüze / Hibrit

Visual Studio, WinDbg, gdb, Process Monitor ve Fiddler ile hata ayıklama araçlarını uygulamalı öğrenin. Digital Vizyon Akademi hata ayıklama araçları eğitimi.

Detayları Gör →
+90 (501) 369 40 14 WhatsApp [email protected] LinkedIn