Kullanım Kılavuzu Süreci¶
Genel Bilgiler¶
| Alan | Değer |
|---|---|
| Süreç Adı | Kullanım Kılavuzu Süreci |
| İlgili SPICE Süreci | SUP.7 Dokümantasyon |
| Süreç Seviyesi | Level 2 - Managed |
| İlişkili Süreçler | Proje Yönetim Süreci, Proje Dokümantasyon Süreci |
| Amaç | Proje çıktıları için nitelikli kullanım kılavuzları hazırlamak |
SPICE Gereksinimler ve Uyumluluk¶
SUP.7 Dokümantasyon Base Practices¶
| Base Practice | Gereksinim | Bu Süreçteki Uygulama |
|---|---|---|
| SUP.7.BP1 | Communication needs identification | Hedef kitle analizi ve dokümantasyon ihtiyaçları belirleme |
| SUP.7.BP2 | Documentation strategy | Dokümantasyon stratejisi ve standartları belirleme |
| SUP.7.BP3 | Document content development | İçerik geliştirme süreci ve şablonlar |
| SUP.7.BP4 | Document production | Dokümantasyon üretim süreci |
| SUP.7.BP5 | Document distribution | Dağıtım ve erişim yönetimi |
| SUP.7.BP6 | Document maintenance | Versiyon yönetimi ve güncelleme süreci |
Süreç Tanımı¶
Amaç¶
Proje çıktıları için hedef kitleye uygun, anlaşılır ve sürdürülebilir kullanım kılavuzları hazırlamak.
Giriş Kriterleri¶
- Proje gereksinim dokümanı onaylandı
- Sistem tasarımı tamamlandı
- Hedef kitle analizi yapıldı
- Dokümantasyon planı hazırlandı
Çıkış Kriterleri¶
- Kullanım kılavuzları tamamlandı ve onaylandı
- Kullanılabilirlik testleri geçildi
- Kılavuzlar uygun formatlarda dağıtıma hazır
- Versiyon kontrolü sistemi kuruldu
Süreç Adımları¶
1. Dokümantasyon Planlama¶
Sorumlu: Teknik Yazar / Business Analyst
SPICE BP: SUP.7.BP1, SUP.7.BP2
Aktiviteler¶
- Hedef Kitle Analizi
- Kullanıcı profilleri belirlenir
- Teknik bilgi seviyesi analiz edilir
-
Kullanım senaryoları tanımlanır
-
Dokümantasyon Stratejisi
- Proje Dokümantasyon Süreci kullanılır
- Kılavuz türleri ve kapsamları belirlenir
-
Standartlar ve şablonlar seçilir
-
Proje Planlama
- Task'lar oluşturulur ve atanır
- Timeline ve milestone'lar belirlenir
Çıktılar¶
- Dokümantasyon Yönetim Planı
- Jira Task'lar
- Hedef kitle analiz raporu
2. Kılavuz Türlerinin Belirlenmesi¶
Sorumlu: Proje Yöneticisi, Teknik Lider
SPICE BP: SUP.7.BP2
Kılavuz Türleri ve İçerikleri¶
| Kılavuz Türü | Hedef Kitle | İçerik | Format | Sorumlu |
|---|---|---|---|---|
| Teknik Kılavuz | Sistem Yöneticileri | Kurulum, konfigürasyon, bakım | PDF + Wiki | Teknik Lider |
| Kullanıcı Kılavuzu | Son Kullanıcılar | Özellik kullanımı, iş akışları | PDF + Video | Business Analyst |
| Yönetici Kılavuzu | İş Sahipleri | Raporlama, yönetim paneli | PDF + Dashboard | Proje Yöneticisi |
| API Dokümantasyonu | Geliştiriciler | Entegrasyon, API referansı | HTML + Swagger | Yazılım Mimarı |
| Hızlı Başlangıç | Tüm Kullanıcılar | Temel işlemler | Kart + Video | UX Designer |
3. İçerik Geliştirme¶
Sorumlu: Teknik Yazar, İlgili Uzmanlar
SPICE BP: SUP.7.BP3
3.1 İçerik Planlama¶
- Kılavuz outline'ı hazırlanır
- Bölüm sorumluları atanır
- İçerik timeline'ı oluşturulur
3.2 İçerik Üretimi¶
- Metin İçeriği
- Kullanıcı senaryoları yazılır
- Adım adım prosedürler oluşturulur
-
Hata durumları ve çözümleri eklenir
-
Görsel İçerik
- Ekran görüntüleri alınır (1920x1080 çözünürlük)
- Akış diyagramları çizilir
-
Video içerikleri hazırlanır
-
İnteraktif İçerik
- Clickable prototipler
- Embedded tutoriallar
- FAQ bölümleri
3.3 İçerik Standartları¶
| Element | Standard | Örnek |
|---|---|---|
| Dosya Adlandırma | [Proje]-[Tip]-[Versiyon] | PROJE-UserGuide-v1.2.pdf |
| Başlık Yapısı | H1-H6 hiyerarşisi | # Ana Başlık, ## Alt Başlık |
| Görsel Standartı | PNG/JPG, min 1920x1080 | Yüksek çözünürlük ekran görüntüleri |
| Video Standartı | MP4, 1080p, max 10 dk | Screen recording + voice over |
| Format | PDF + Markdown + HTML | Multi-format desteği |
4. Kalite Kontrol ve Doğrulama¶
Sorumlu: Kalite Güvence, Teknik Uzmanlar
SPICE BP: SUP.7.BP4
4.1 Teknik Doğruluk Kontrolü¶
- Prosedürler adım adım test edilir
- Ekran görüntüleri güncel mi kontrol edilir
- API örnekleri çalıştırılır
- Hata senaryoları doğrulanır
4.2 Kullanılabilirlik Testi¶
- Hedef kitle temsilcileriyle test edilir
- Anlaşılabilirlik değerlendirilir
- Navigasyon kolaylığı kontrol edilir
- Feedback toplanır ve uygulanır
4.3 Dil ve Format Kontrolü¶
- Yazım ve dilbilgisi kontrolü
- Terminoloji tutarlılığı
- Format standartlarına uyumluluk
- Görsel kalite kontrolü
5. Versiyon Yönetimi ve Dağıtım¶
Sorumlu: Konfigürasyon Yöneticisi
SPICE BP: SUP.7.BP5, SUP.7.BP6
5.1 Versiyon Kontrolü¶
- Git'te branch-based versiyon yönetimi
- Konfigürasyon Yönetim Süreci uygulanır
- Release notes hazırlanır
- Semantic versioning kullanılır (v1.2.3)
5.2 Dağıtım Kanalları¶
| Kanal | Format | Hedef Kitle | Güncelleme |
|---|---|---|---|
| İnternal Wiki | HTML/Markdown | İç Ekip | Real-time |
| Müşteri Portalı | PDF/HTML | Müşteriler | Release-based |
| Developer Portal | HTML/Swagger | Geliştiriciler | API release |
| Help Desk | PDF/Searchable | Support Ekip | Weekly |
5.3 Güncelleme Süreci¶
- Change Request değerlendirmesi
- Impact analizi yapılır
- Güncelleme planlanır
- Test edilir ve onaylanır
- Dağıtım yapılır
- Kullanıcılara bilgilendirme
Roller ve Sorumluluklar¶
| Rol | Sorumluluklar |
|---|---|
| Teknik Yazar | İçerik yazımı, format kontrolü, güncelleme |
| Business Analyst | Kullanıcı senaryoları, iş akışları, UAT |
| Teknik Lider | Teknik doğruluk, API dokümantasyonu |
| UX Designer | Görsel tasarım, kullanılabilirlik |
| Kalite Güvence | Review, test, onay süreçleri |
| Proje Yöneticisi | Planlama, koordinasyon, milestone takibi |
Metrikler ve KPI'lar¶
| Metrik | Hedef | Ölçüm Yöntemi | Sıklık |
|---|---|---|---|
| Dokümantasyon Tamamlanma | %100 | Jira task completion | Weekly |
| Kullanılabilirlik Skoru | >4.0/5.0 | Kullanıcı anketi | Post-release |
| Hata Oranı | <2% | Review findings | Per review |
| Güncelleme Süresi | <48h | Change request'ten dağıtıma | Per update |