Katkı Rehberi

Handbook'a katkı rehberi — sayfa oluşturma, düzenleme, inceleme süreci, yazım standartları ve MR kuralları

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.

Katkı Türleri

TürAçıklamaZorlukSüre
DüzeltmeYazım hatası, kırık link, format düzeltmeKolay5-15 dk
GüncellemeMevcut bilginin güncellenmesiKolay-Orta15-60 dk
Yeni SayfaYeni bir handbook sayfası oluşturmaOrta1-4 saat
Yeniden YapılandırmaBölüm yapısının değiştirilmesiZor2-8 saat
Politika DeğişikliğiMevcut politikanın değiştirilmesiZorDeğişken

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üİnceleyiciSLA
DüzeltmeHerhangi bir ekip üyesi1 iş günü
GüncellemeDepartman sahibi2 iş günü
Yeni SayfaDepartman sahibi + 1 ek inceleyici3 iş günü
Yeniden YapılandırmaDepartman sahibi + liderlik temsilcisi5 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>
---
AlanAçıklamaZorunlu
titleSayfa başlığı (Türkçe, büyük harfle başlar)Evet
description1 cümle açıklama + anahtar konularEvet
typeSayfa türüEvet
statusSayfa durumuEvet
dseSorumlu ekip (DSE kodu)Evet
tagsEtiketler (en az 3)Evet
date_createdOluşturma tarihi (YYYY-MM-DD)Evet
has_agent_protocolYapay Zeka Asistanı protokolü var mıEvet
last_reviewedSon inceleme tarihiÖnerilen
review_cadenceİnceleme sıklığıÖnerilen
aliasesAlternatif sayfa adlarıOpsiyonel

Sayfa Türleri

TürKullanımÖrnek
referenceBilgilendirme, açıklamaDepartman sayfası, ürün sayfası
guideNasıl yapılır rehberiUzaktan çalışma rehberi, katkı rehberi
policyPolitika ve kuralÇeşitlilik politikası, güvenlik politikası
processSü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 referans1-3K karakter
Standart sayfa3-6K karakter
Detaylı rehber6-10K karakter
Playbook8-15K karakter

Yazım Standartları

Türkçe Karakter Kuralları

KuralDoğruYanlış
Türkçe karakterler kullanılmalımüşteri, ürün, şirketmusteri, urun, sirket
İngilizce terimlere Türkçe karakter eklenmezdashboard, sprint, meetingdashböard, spriınt
Dosya adlarında Türkçe karakter yokmusteri-basari.mdmüşteri-başarı.md
Dosya adları kebab-casetoplanti-kulturu.mdtoplanti_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ı

CalloutKullanı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ç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:

KategoriAnlamıAksiyon
Engelleyici (Blocking)MR birleştirilemezDüzeltilmeli
Öneri (Suggestion)İyileştirme önerisiİsteğe bağlı
Soru (Question)Açıklama gerekiyorYanıtlanmalı
Övgü (Praise)Güzel katkıTeşekkür

Yapay Zeka Asistanı Katkıları

Yapay Zeka Asistanları da handbook'a katkıda bulunabilir:

KuralDetay
Yapay Zeka Asistanı MR oluşturabiliryetkinlik seviyesine uygun değişiklikler
İnsan onayı zorunluYapay Zeka Asistanı MR'ları birleştirmeden önce insan onayı gerekir
Yapay Zeka Asistanı inceleme yapabilirFormat ve yapı kontrolleri otomatik yapılabilir
İçerik doğrulamaİçerik doğruluğu insan tarafından kontrol edilir

Sık Yapılan Hatalar

HataDüzeltme
Frontmatter'da has_agent_protocol eksikHer sayfada zorunlu (true veya false)
Tablo içi wiki-link'te escaped pipe yokMetin formatı kullan
Bilgi kopyalama (SSOT ihlali)Link ver, kopyalama
Çok uzun cümlelerKısa, net cümleler kur
İngilizce terime Türkçe karakterdashboard (dashböard değil)
Dosya adında Türkçe karaktertoplanti-kulturu.md (toplantı-kültürü.md değil)
İlgili sayfalar bölümü eksik2-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