Katkı Rehberi
5 minute read
Katkı Rehberi
Denomas Handbook yaşayan bir belgedir. Her ekip üyesi (insan veya Yapay Zeka Asistanı) katkıda bulunabilir ve bulunması beklenir. Bu rehber handbook'a katkı sürecini, yazım standartlarını ve inceleme kurallarını tanımlar.
Handbook genel yönetimi @liderlik-ekibi sorumluluğundadır. Her departman kendi bölümünün güncelliğinden sorumludur.
Katkı Türleri
| Tür | Açıklama | Zorluk | Süre |
|---|---|---|---|
| Düzeltme | Yazım hatası, kırık link, format düzeltme | Kolay | 5-15 dk |
| Güncelleme | Mevcut bilginin güncellenmesi | Kolay-Orta | 15-60 dk |
| Yeni Sayfa | Yeni bir handbook sayfası oluşturma | Orta | 1-4 saat |
| Yeniden Yapılandırma | Bölüm yapısının değiştirilmesi | Zor | 2-8 saat |
| Politika Değişikliği | Mevcut politikanın değiştirilmesi | Zor | Değişken |
İlk katkınız için bir yazım hatası düzeltmesi veya küçük güncelleme ile başlayın. Süreç hakkında pratik kazanırsınız.
Katkı Süreci
1. Sorun veya İhtiyaç Tespiti
Katkı ihtiyacı şu kaynaklardan doğabilir:
- Eksik veya güncel olmayan bilgi fark etme
- Yeni süreç veya politika oluşturma
- Toplantıda alınan karar
- Müşteri veya ekip üyesi geri bildirimi
- Yapay Zeka Asistanı tarafından tespit edilen tutarsızlık
2. Issue Oluşturma (Opsiyonel)
Büyük değişiklikler (yeni sayfa, yeniden yapılandırma, politika değişikliği) için önce code.denomas.com'da issue oluşturulur:
Başlık: [Handbook] <Değişiklik Özeti>
Açıklama:
- Mevcut durum
- Önerilen değişiklik
- Gerekçe
- Etkilenen sayfalar
Etiketler: handbook, <departman>
3. Branch Oluşturma
handbook/<degisiklik-tipi>/<kisa-aciklama>
Örnekler:
handbook/fix/yazim-hatasi-destek-sayfasi
handbook/add/toplanti-kulturu
handbook/update/sla-standartlari
handbook/restructure/culture-bolumu
4. Değişiklikleri Yapma
Handbook sayfaları aşağıdaki kurallara uygun olarak oluşturulur veya düzenlenir.
5. MR (Merge Request) Oluşturma
Başlık: [Handbook] <Değişiklik Özeti>
Açıklama:
## Ne değişti?
- <Değişiklik 1>
- <Değişiklik 2>
## Neden?
<Gerekçe>
## Kontrol Listesi
- [ ] Frontmatter eksiksiz
- [ ] Türkçe karakterler doğru
- [ ] Wiki-linkler çalışıyor
- [ ] SSOT prensibi korunuyor
- [ ] İlgili sayfalar bölümü güncel
6. İnceleme
| Değişiklik Türü | İnceleyici | SLA |
|---|---|---|
| Düzeltme | Herhangi bir ekip üyesi | 1 iş günü |
| Güncelleme | Departman sahibi | 2 iş günü |
| Yeni Sayfa | Departman sahibi + 1 ek inceleyici | 3 iş günü |
| Yeniden Yapılandırma | Departman sahibi + liderlik temsilcisi | 5 iş günü |
| Politika Değişikliği | İlgili DSE + liderlik onayı | 5 iş günü |
7. Birleştirme ve Yayın
- İnceleme onayı alındıktan sonra MR birleştirilir
- Handbook otomatik olarak yayınlanır
- Önemli değişiklikler ilgili kanallarda duyurulur
Sayfa Yapısı Standartları
Frontmatter (Zorunlu)
Her handbook sayfasında şu frontmatter alanları zorunludur:
---
title: "Sayfa Başlığı"
description: "Kısa açıklama — em dash ile ayrılmış anahtar konular"
type: <reference|guide|policy|process>
status: <draft|stable|deprecated>
dse: "@sorumluluk-ekibi"
tags: [etiket1, etiket2, etiket3]
date_created: 2026-03-16
has_agent_protocol: <true|false>
---
| Alan | Açıklama | Zorunlu |
|---|---|---|
| title | Sayfa başlığı (Türkçe, büyük harfle başlar) | Evet |
| description | 1 cümle açıklama + anahtar konular | Evet |
| type | Sayfa türü | Evet |
| status | Sayfa durumu | Evet |
| dse | Sorumlu ekip (DSE kodu) | Evet |
| tags | Etiketler (en az 3) | Evet |
| date_created | Oluşturma tarihi (YYYY-MM-DD) | Evet |
| has_agent_protocol | Yapay Zeka Asistanı protokolü var mı | Evet |
| last_reviewed | Son inceleme tarihi | Önerilen |
| review_cadence | İnceleme sıklığı | Önerilen |
| aliases | Alternatif sayfa adları | Opsiyonel |
Sayfa Türleri
| Tür | Kullanım | Örnek |
|---|---|---|
| reference | Bilgilendirme, açıklama | Departman sayfası, ürün sayfası |
| guide | Nasıl yapılır rehberi | Uzaktan çalışma rehberi, katkı rehberi |
| policy | Politika ve kural | Çeşitlilik politikası, güvenlik politikası |
| process | Süreç tanımı | Onboarding playbook, eskalasyon süreci |
Sayfa İçerik Yapısı
# Başlık
Giriş paragrafı (1-2 cümle, sayfanın amacını açıklar)
> [!DSE] Sorumluluk
> DSE bilgisi
## Ana Bölüm 1
### Alt Bölüm 1.1
## Ana Bölüm 2
## AgentProtocol (varsa)
---
## İlgili Sayfalar
- Görünen Metin 1
- Görünen Metin 2
Sayfa Uzunluğu
| Tür | Önerilen Uzunluk |
|---|---|
| Kısa referans | 1-3K karakter |
| Standart sayfa | 3-6K karakter |
| Detaylı rehber | 6-10K karakter |
| Playbook | 8-15K karakter |
Yazım Standartları
Türkçe Karakter Kuralları
| Kural | Doğru | Yanlış |
|---|---|---|
| Türkçe karakterler kullanılmalı | müşteri, ürün, şirket | musteri, urun, sirket |
| İngilizce terimlere Türkçe karakter eklenmez | dashboard, sprint, meeting | dashböard, spriınt |
| Dosya adlarında Türkçe karakter yok | musteri-basari.md | müşteri-başarı.md |
| Dosya adları kebab-case | toplanti-kulturu.md | toplanti_kulturu.md |
Cümle Yapısı
- Kısa ve net cümleler tercih edilir
- Hedef kitle: 20-55 yaş insan + Yapay Zeka Asistanı
- Çift anlamlı kelimelerden kaçınılır
- Jargon kullanıldığında açıklama eklenir
Callout Kullanımı
| Callout | Kullanım |
|---|---|
> [!INFO] | Bilgilendirme, ek bağlam |
> [!TIP] | Faydalı ipucu, en iyi uygulama |
> [!WARNING] | Dikkat edilmesi gereken durum |
> [!DANGER] | Kritik uyarı, risk |
> [!DSE] | Sorumluluk bilgisi (DSE kodu) |
> [!NOTE] | Ek not, hatırlatma |
Tablo İçi Wiki-Link
Tablo içinde wiki-link kullanırken pipe karakteri escaped olmalıdır:
| Doğru | Yanlış |
|---|---|
| Görünen Metin | Görünen Metin |
SSOT (Single Source of Truth)
- Her bilgi tek yerde bulunur
- Bilgiyi kopyalamak yerine link ver
- Bir bilgi değiştiğinde tek yeri güncelle
✅ Doğru: Destek SLA süreleri için bkz. [SLA Standartları](/support/sla-standards/)
❌ Yanlış: Destek SLA süreleri: P1=1 saat, P2=4 saat... (kopyalama)
İlgili Sayfalar Bölümü
Her sayfanın sonunda 2-5 arası ilgili sayfa linki bulunmalıdır:
---
## İlgili Sayfalar
- Görünen Metin 1
- Görünen Metin 2
- Görünen Metin 3
İnceleme Süreci
İnceleme Kontrol Listesi
İnceleyiciler şu kontrol listesini kullanır:
Yapı:
- Frontmatter eksiksiz ve doğru
- Sayfa yapısı standartlara uygun
- İlgili sayfalar bölümü mevcut (2-5 link)
İçerik:
- Bilgi doğru ve güncel
- SSOT prensibi korunuyor (kopyalama yok)
- Cümleler kısa ve net
- Çift anlamlı kelime yok
Format:
- Türkçe karakterler doğru kullanılmış
- İngilizce terimlere Türkçe karakter eklenmemiş
- Dosya adı kebab-case
- Tablo içi wiki-linkler escaped
- Callout'lar doğru kullanılmış
Yasaklar:
- Yasaklı terimler yok (dini metafor, yasaklı kalıplar)
- DSE kodları ASCII formatında
- Kişisel veri veya gizli bilgi yok
İnceleme Geri Bildirimi
İnceleyici geri bildirimi şu kategorilerde verilir:
| Kategori | Anlamı | Aksiyon |
|---|---|---|
| Engelleyici (Blocking) | MR birleştirilemez | Düzeltilmeli |
| Öneri (Suggestion) | İyileştirme önerisi | İsteğe bağlı |
| Soru (Question) | Açıklama gerekiyor | Yanıtlanmalı |
| Övgü (Praise) | Güzel katkı | Teşekkür |
Yapay Zeka Asistanı Katkıları
Yapay Zeka Asistanları da handbook'a katkıda bulunabilir:
| Kural | Detay |
|---|---|
| Yapay Zeka Asistanı MR oluşturabilir | yetkinlik seviyesine uygun değişiklikler |
| İnsan onayı zorunlu | Yapay Zeka Asistanı MR'ları birleştirmeden önce insan onayı gerekir |
| Yapay Zeka Asistanı inceleme yapabilir | Format ve yapı kontrolleri otomatik yapılabilir |
| İçerik doğrulama | İçerik doğruluğu insan tarafından kontrol edilir |
Yapay Zeka Asistanlarının handbook katkıları AI-Force Genel Bakış sayfasındaki yetki matrisine tabidir.
Sık Yapılan Hatalar
| Hata | Düzeltme |
|---|---|
Frontmatter'da has_agent_protocol eksik | Her sayfada zorunlu (true veya false) |
| Tablo içi wiki-link'te escaped pipe yok | Metin formatı kullan |
| Bilgi kopyalama (SSOT ihlali) | Link ver, kopyalama |
| Çok uzun cümleler | Kısa, net cümleler kur |
| İngilizce terime Türkçe karakter | dashboard (dashböard değil) |
| Dosya adında Türkçe karakter | toplanti-kulturu.md (toplantı-kültürü.md değil) |
| İlgili sayfalar bölümü eksik | 2-5 wiki-link ekle |
AgentProtocol
agent_protocol:
trigger: "handbook_contribution_request"
allowed_agents: ["handbook-agent", "cs-agent", "support-agent"]
competency_level: "PROG:2"
actions:
- action: "validate_frontmatter"
description: "Frontmatter formatını doğrula"
requires_human: false
- action: "check_writing_standards"
description: "Yazım standartlarını kontrol et"
requires_human: false
- action: "verify_ssot"
description: "SSOT prensibini doğrula (kopyalama tespiti)"
requires_human: false
- action: "create_mr"
description: "MR oluştur ve inceleyici ata"
requires_human: false
- action: "approve_merge"
description: "MR birleştirme onayı"
requires_human: true
approver: "department_owner"
escalation:
timeout_minutes: 4320
escalate_to: "handbook_maintainer"
audit_log: true
İlgili Sayfalar
- Kültür
- Handbook-First Yaklaşımı
- İletişim Standartları
- AI-Force Genel Bakış
- Araç ve İpuçları
Geribildirim
Bu sayfa yararlı oldu mu?
Bu sayfa faydali oldu
Bu sayfa gelistirilmeli
