Confluence kullanımı: dokümantasyonu düzenli tutmanın yolu

Confluence dokümantasyonda hangi sorunu çözer?

Ekip bilgisi çoğu zaman e-posta zincirlerinde, sohbet kanallarında ve kişisel dosyalarda dağılır. Yeni gelen kişi bir kararın nedenini bulamaz, kıdemli çalışan aynı soruyu tekrar tekrar cevaplar, ayrılan biriyle birlikte bilgi de gider. Confluence bu bilgiyi tek yerde, aranabilir ve sürümlenmiş biçimde tutmak için kullanılan bir ekip çalışma alanıdır.

Atlassian'ın tanımına göre içerik sayfalarda yaşar; sayfalar, iş birliği için ayrılmış çalışma alanları olan space'lerde saklanır ve space içinde sayfalar hiyerarşik bir ağaç oluşturur. Şablonlar belirli sayfa türlerini hızlıca başlatır, beyaz tahtalar ise beyin fırtınası ve planlama için serbest tuval sunar. Aracın kendisi basittir; asıl iş, hangi bilginin nerede ve hangi biçimde duracağına karar vermektir.

Space yapısını nasıl tasarlarsınız?

Space, dokümantasyonun en büyük kutusudur ve yanlış kurulursa sonradan düzeltmesi zordur. Ayırma ölçütü olarak ekip, ürün ya da bilginin hedef kitlesi kullanılabilir. Pratik bir ayrım şudur: • Ekip space'i: o ekibin günlük işini taşır (toplantı notları, karar kayıtları, sprint değerlendirmeleri). • Ürün veya proje space'i: bir ürünün gereksinimleri, mimari notları, sürüm bilgileri. • Bilgi bankası: kendi başına okunabilen, dışarıya ya da diğer ekiplere dönük yönergeler ve sık sorulan sorular. • Kişisel alan: taslaklar için; yayına çıkan bilgi buradan taşınır.

Her space'in bir ana sayfası olsun. Bu sayfa space'in amacını, sahibini ve sayfa ağacının ana başlıklarını gösteren bir içindekiler tablosu gibi çalışsın. Space sayısını kontrolsüz artırmak da bir hatadır: bilgi çok yere dağılır ve arama güvenilirliğini yitirir. Yeni space açmadan önce mevcut bir space'in altında bölüm açmanın yeterli olup olmadığını tartın.

Sayfa ağacı, adlandırma ve şablonlar

Sayfa ağacı klasör yapısı gibi düşünülmelidir: üst sayfa konuyu, alt sayfalar ayrıntıyı taşır. Ağacı çok derin tutmayın; birkaç kademeden sonra kimse içeriği bulamaz. Başlıkları arama motoru gibi düşünerek yazın: “Toplantı notu” yerine “Haftalık planlama toplantısı notu, ürün ekibi” gibi, tek başına anlaşılan başlıklar seçin.

Yeni sayfa açarken boş sayfa yerine şablon kullanmak tutarlılık sağlar. En sık gereken şablonlar: • Toplantı notu: katılımcılar, gündem, alınan kararlar, aksiyonlar ve sorumluları. • Karar kaydı: bağlam, değerlendirilen seçenekler, verilen karar, gerekçe ve etkilenen taraflar. • Operasyon rehberi (runbook): bir sorun çıkınca atılacak adımlar. • Katılım (onboarding) listesi: yeni gelen için ilk günlerde okunacak sayfalar. • Ürün gereksinimi veya teknik tasarım: amaç, kapsam, açık sorular.

Confluence'ta ekibinize özel şablon tanımlayabilirsiniz; boşluk bırakılacak alanlara ipucu metni koyarsanız yazar neyi dolduracağını bilir. Şablon sayısını sınırlı tutun: çok şablon, seçim yorgunluğuna yol açar.

Makrolar ve etiketlerle sayfaları canlı tutmak

Makrolar sayfaya dinamik içerik ekler. Örneğin bir alt sayfa listesi makrosu, ana sayfanın içindekileri kendiliğinden güncel tutar; kod bloğu, bilgi kutusu, durum etiketi ve içindekiler tablosu gibi yapılar okunabilirliği artırır. Atlassian'ın yönergesi, makroları Confluence içeriğini sayfalarda göstermek için kullanmayı önerir. Makroyu süs olarak değil, el ile güncelleme yükünü azaltmak için kullanın.

Etiketler (labels) sayfaları space sınırlarını aşarak gruplamanın yoludur. Atlassian bunu “içeriği, insanlar hızlıca bulabilsin diye etiketlemek” diye anlatır. Küçük ve ortak bir etiket sözlüğü belirleyin: örneğin yönerge, karar, sorun-giderme, onboarding. Herkes kendi etiketini icat ederse sözlük dağılır. Etiket makrosuyla belirli bir etikete sahip tüm sayfaları tek sayfada listeleyip canlı bir dizin oluşturabilirsiniz.

İzinler, sahiplik ve güncel tutma

Dokümantasyonun asıl düşmanı eskimedir; yanlış bilgi bilgi olmamasından kötüdür. Her önemli sayfanın bir sahibi olsun ve sayfa üstünde görünsün. Sahip, sayfanın doğruluğundan sorumludur. Periyodik bir gözden geçirme düzeni kurun: ekip toplantısında en çok okunan ve en kritik sayfaların kısa bir turu yeterlidir. Eskimiş ama silinmesi riskli sayfaları arşiv bölümüne taşıyın, sayfa başına “eski” uyarısı koyun.

İzinleri katmanlı düşünün. Space düzeyinde kimlerin okuyup yazabileceğini belirleyin; Atlassian bunu space seviyesinde izin yönetimi olarak ayrıca belgeler. İçerik düzeyinde ise belirli bir sayfayı kısıtlamak mümkündür, ancak bunu istisna olarak tutun. Çoğu bilgi açık olduğunda hem yeni gelenler çabuk öğrenir hem de ekipler arası tekrar azalır. Hassas içerik (İK, sözleşme, güvenlik) için ayrı bir space ve dar yetki daha temiz bir çözümdür.

Sürüm geçmişi, bir sayfada neyin ne zaman değiştiğini geri izlemeye izin verir; yanlış bir düzenleme olduğunda önceki sürüme dönmek mümkündür. Önemli değişikliklerde sayfa açıklamasına kısa bir değişiklik notu bırakmak denetimi kolaylaştırır.

Jira ile birlikte kullanım

Yazılım ve ürün ekiplerinde Confluence çoğunlukla Jira ile birlikte çalışır. Jira işi ve durumunu, Confluence ise işin “neden”ini ve bağlamını taşır. Gereksinim sayfasından ilgili Jira kayıtlarına bağlantı vermek, kayıt tarafında da gereksinim sayfasına bağlantı bırakmak izlenebilirlik sağlar. Sayfaya Jira kayıtlarını canlı gösteren bir görünüm eklerseniz, sprint durumu için ayrı bir rapor yazmanıza gerek kalmaz.

Pratik kural: kararı ve gerekçeyi Confluence'ta, işi ve ilerleyişi Jira'da tutun, bunları birbirine bağlayın. Aynı bilgiyi birden çok yerde elle yazarsanız biri mutlaka eskir.

Sık yapılan hatalar

• Önce araç, sonra yapı: Space ve ağaç tasarlanmadan sayfa yazmaya başlamak birkaç ay sonra dağınıklık getirir.
• Sahipsiz sayfa: Kimsenin sorumlu olmadığı sayfa eskir ve güveni zedeler.
• Her şeyi yazmak: Dokümantasyon, değişen şeyi değil, kalıcı olanı hedeflemeli; hızlı değişen ayrıntıyı koda veya Jira'ya bırakın.
• Başlık ve etiket disiplini olmaması: Arama sonuçları gürültülü olur, kullanıcı aramayı bırakıp insanlara sormaya döner.
• Aşırı kısıtlama: Her sayfayı kısıtlamak bilgiyi görünmez kılar ve aynı sorunun tekrar sorulmasına yol açar.
• Yazmayı kimsenin işi saymamak: Dokümantasyon görev tanımında ve ekip çalışma düzeninde yer almazsa gönüllülüğe kalır.

Bir ekibin Confluence düzeni, kullanım alışkanlıklarının tutarlı olmasıyla değer kazanır; araç özellikleri ikinci plandadır.

Mindset programlarında bu beceri nerede çalışılır?

Confluence ile ekip dokümantasyonu kuran ve yönetecek kişiler için Mindset'in Confluence ile Bilgi Yönetimi eğitimi; Space Mimarisi ve Bilgi Tasarımı, Şablon ve Makro ile Verimli İçerik, Arama, Sürüm ve İzin Yönetimi ile Confluence Kurumsal Yerleşim Stratejisi gibi modüllerle bu yapıyı ele alır. Proje yöneticileri, ürün sahipleri, teknik yazarlar ve bilgi yönetimi sorumluları için uygundur.

Jira ve Confluence'ı birlikte kullanan ekipler için Jira + Confluence Kombinasyonu eğitimi; Confluence Dokümantasyon Hizalama ve Jira-Confluence Entegrasyon Senaryoları modülleriyle iş takibi ile dokümantasyonu birbirine bağlama sorununu işler. Kurumsal ekipler bu eğitimlerden, kendi space yapısını ve şablon sözlüğünü ortak bir standarda oturtmak için yararlanabilir.