Wiki Modu

Wiki modu, bir projenin sayfalarını özel kenar çubuğu navigasyonu, otomatik oluşturulan içindekiler tablosu ve gelişmiş arama ile yapılandırılmış bir bilgi tabanına dönüştürür. Normal sayfalar esnek ve gevşek organize iken, wiki modu uzun ömürlü, ekip genelinde dokümantasyon için tasarlanmış daha yapılandırılmış bir yaklaşım uygular.

Wiki ve normal sayfalar karşılaştırması

Özellik	Normal sayfalar	Wiki modu
Organizasyon	İsteğe bağlı iç içe geçmeyle düz liste	Açık hiyerarşiyle ağaç tabanlı yapı
Navigasyon	Kenar çubuğu listesi, breadcrumb'lar	Genişletilebilir ağaçla özel wiki kenar çubuğu
İçindekiler tablosu	Oluşturulmaz	Her sayfadaki başlıklardan otomatik oluşturulur
Arama	Standart sayfa arama	Tüm wiki sayfalarında gelişmiş wiki araması
Hedeflenen ömür	Notlar, taslaklar, geçici belgeler	Kalıcı referans dokümantasyonu
Düzenleme	Herhangi bir proje üyesi (erişime bağlı)	Herhangi bir proje üyesi (erişime bağlı)
Yayınlama	Sayfa bazında yayınlama	Sayfa bazında yayınlama

Wiki modunu etkinleştirme

Wiki modu proje düzeyinde etkinleştirilir.

1. Proje Ayarları'nı açın.
2. Özellikler bölümüne gidin.
3. Wiki geçişini bulun ve etkinleştirin.
4. Proje kenar çubuğunda yeni bir Wiki bölümü görünür.

İPUCU

Wiki modunu etkinleştirmek mevcut normal sayfaları etkilemez. Aynı proje içinde hem normal sayfaları hem de wiki sayfalarını kullanabilirsiniz. Bunlar ayrı koleksiyonlardır.

Wiki sayfası oluşturma

Wiki modu etkinleştirildikten sonra:

1. Proje kenar çubuğundaki Wiki bölümüne tıklayın.
2. Wiki kenar çubuğunun üstündeki Yeni Sayfa'ya tıklayın.
3. Bir başlık girin ve yazmaya başlayın.
4. Sayfa otomatik olarak wiki ağacına eklenir.

Wiki'de alt sayfalar oluşturma

1. Kenar çubuğunda mevcut bir wiki sayfasının üzerine gelin.
2. Alt sayfa eklemek için + simgesine tıklayın.
3. Yeni sayfa, wiki ağacında üst öğenin altında iç içe geçmiş olarak görünür.

Alt sayfalar İç İçe Sayfalar ile aynı şekilde çalışır — sürükle ve bırak yeniden sıralamayı, üst öğeler arasında taşımayı ve breadcrumb navigasyonunu desteklerler.

Wiki yapısı

Wiki kenar çubuğu, tüm wiki sayfalarını ağaç formatında görüntüler:

Wiki
├── Başlangıç
│   ├── Kurulum
│   ├── Yapılandırma
│   └── İlk Adımlar
├── Mimari
│   ├── Backend
│   ├── Frontend
│   └── Veritabanı
├── Süreçler
│   ├── Sürüm Süreci
│   ├── Kod İncelemesi
│   └── Nöbet Rotasyonu
└── SSS

Wiki'nizi yapılandırma

İyi yapılandırılmış bir wiki şu ilkeleri izler:

İlke	Kılavuz
Üst düzey bölümler	Ana alanları temsil eder (örneğin, Başlangıç, Mimari, Süreçler)
İkinci düzey	Her alan içindeki belirli konuları temsil eder
Üçüncü düzey ve daha derin	Ayrıntılı alt konular için tutumlu kullanın
Adlandırma	Kendi başına durabilen açık ve açıklayıcı sayfa başlıkları kullanın
Sıralama	En çok erişilen sayfaları her bölümün üstüne yerleştirin

Wiki navigasyonu

Kenar çubuğu ağacı

Wiki kenar çubuğu kalıcı navigasyon sağlar:

• Açmak için bir sayfaya tıklayın.
• Alt sayfaları genişletmek veya daraltmak için oka tıklayın.
• Mevcut sayfa vurgulanır.
• Ağaç durumu (genişletilmiş/daraltılmış) oturumlar arasında kalıcıdır.

İçindekiler tablosu

Her wiki sayfası, başlıklarından otomatik olarak içindekiler tablosu oluşturur. İçindekiler tablosu, görüntülenirken sayfanın sağ tarafında görünür ve her bölüme atlama bağlantıları sağlar.

Başlık düzeyi	İçindekiler'e dahil
H1	Evet
H2	Evet
H3	Evet
H4	Evet (girintili)
H5	Hayır
H6	Hayır

Breadcrumb'lar

Breadcrumb navigasyonu her wiki sayfasının üstünde görünür:

Proje > Wiki > Mimari > Backend

Her segment, doğrudan navigasyon için tıklanabilir.

Wiki arama

Wiki kenar çubuğunun üstündeki wiki arama çubuğu, tüm wiki sayfalarında arama yapar.

1. Arama simgesine tıklayın veya wiki kenar çubuğu odaklanmışken / tuşuna basın.
2. Sorgunuzu yazın.
3. Sonuçlar eşleşen sayfa başlıklarını ve içerik parçacıklarını gösterir.
4. Sayfayı açmak için bir sonuca tıklayın.

Wiki araması şunları indeksler:

• Sayfa başlıkları
• Sayfa gövde içeriği
• Başlık metni

İPUCU

Wiki sayfalarını, iş öğelerini ve daha fazlasını içeren çalışma alanı genelinde arama için global aramayı kullanın (Ctrl+K / Cmd+K).

Wiki sayfalarını yönetme

Sayfaları yeniden sıralama

Sırayı değiştirmek için wiki kenar çubuğundaki sayfaları sürükleyip bırakın. Sıra tüm proje üyeleri arasında paylaşılır.

Sayfaları taşıma

Üst öğesini değiştirmek veya wiki kök düzeyine taşımak için bir wiki sayfasına sağ tıklayın ve Şuraya taşı'yı seçin.

Wiki sayfalarını arşivleme

Eski ancak korunmaya değer sayfalar arşivlenebilir. Arşivlenen wiki sayfaları kenar çubuğundan gizlenir ancak arşiv görünümünden geri yüklenebilir.

Wiki sayfalarını silme

Kalıcı olarak kaldırmak için bir wiki sayfasına sağ tıklayın ve Sil'i seçin. Sayfanın alt öğeleri varsa, alt öğeleri silmeniz veya bir düzey yukarı taşımanız istenir.

UYARI

Wiki sayfasını silmek kalıcıdır. İçerik gelecekte yararlı olabilirse bunun yerine arşivlemeyi düşünün.

Kullanım senaryoları

Ekip işe alım kılavuzu

Her ekip için bölümler içeren bir işe alım wiki'si oluşturun:

• Şirket genel bakışı ve değerleri
• Geliştirme ortamı kurulumu
• Temel araçlar ve erişim
• Ekibe özgü süreçler
• Yeni çalışanlar için SSS

Mühendislik bilgi tabanı

Teknik kararları ve mimariyi belgeleyin:

• Sistem mimarisi diyagramları
• API dokümantasyonu
• Veritabanı şemaları
• Dağıtım süreçleri
• Olay müdahale prosedürleri

Süreç dokümantasyonu

Ekip süreçlerini standartlaştırın:

• Sprint planlama kılavuzu
• Kod inceleme kontrol listesi
• Sürüm süreci
• Nöbet el kitabı
• Tasarım inceleme iş akışı

Ürün dokümantasyonu

Dahili ürün referansını koruyun:

• Özellik spesifikasyonları
• Kullanıcı araştırması bulguları
• Ürün yol haritası notları
• Rekabetçi analiz

En iyi uygulamalar

• Wiki sahipleri atayın — wiki yapısından ve kalitesinden sorumlu bir veya iki kişi belirleyin.
• Düzenli olarak inceleyin — eski içeriği arşivlemek ve güncel olmayan sayfaları güncellemek için üç aylık incelemeler planlayın.
• Şablonlar kullanın — yaygın sayfa türleri için şablonlar oluşturun (örneğin, ADR şablonu, çalışma kılavuzu şablonu). Bkz. Sayfa Şablonları.
• Wiki sayfaları arasında bağlantı kurun — okuyucuların ilgili içeriği keşfetmesine yardımcı olmak için ilgili konulara çapraz referans verin.
• Küçük başlayın — en kritik dokümantasyonla başlayın ve ekip katkıda bulundukça genişletin.

İlgili sayfalar

• Sayfaları Yönet — Sayfa oluşturma ve yönetimi
• İç İçe Sayfalar — Hiyerarşik sayfa yapısı
• Sayfa Düzenleyici — Zengin metin düzenleme kılavuzu
• Sayfa Şablonları — Yeniden kullanılabilir sayfa şablonları
• Sayfa Erişim Kontrolü — İzinler ve paylaşım
• Yayınlama — Sayfaları herkese açık paylaşın