Uzman Dokümantasyon

API ve yazılım şirketlerinde dokümantasyon çoğu zaman kod deposundaki dağınık dosyalarda ya da eski bir wiki sayfasında kalır. Geliştiriciler doğru bilgiyi bulamadığında destek ekibine yazar ya da entegrasyonu yarıda bırakır. Uzman Dokümantasyon bu içerikleri düzenli bir dokümantasyon sitesinde toplar. Sayfalar başlangıç, rehberler, API başvurusu ve dağıtım gibi bölümlerden oluşan bir içerik ağacında sıralanır.

Teknik yazarın en çok zaman kaybettiği yer, yazdığı metnin yayında nasıl görüneceğini kestirmektir. Panelde kaynak Markdown solda, işlenmiş önizleme sağda yan yana durur. Başlıklar, kod blokları ve bilgi kutuları yazıldıkça önizlemede görünür. Kod blokları dil etiketi ve satır numarasıyla gösterilir. Sayfa yolu üst satırda yazar. Yayınla düğmesiyle sayfa canlıya alınır ve yayında etiketi görünür.

Yayınlanan dokümanın işe yarayıp yaramadığını bilmek de gerekir. Panelin üstünde toplam sayfa sayısı, aylık görüntülenme, sitede yapılan arama sorguları ve okuyucu oylarından hesaplanan faydalılık oranı yer alır. İçerik ağacında her sayfanın görüntülenme sayısı yanında yazar. Yayında, incelemede ve taslak durumundaki sayfa sayıları ayrıca gösterilir. Analitik bölümü ayrıntılı inceleme için ayrılmıştır.

• API sunan yazılım şirketleri, uç nokta başvurularını ve kullanım rehberlerini düzenli bir sitede yayınlar.
• Teknik yazarlar, Markdown ile yazdıkları sayfaları canlı önizlemeyle kontrol edip yayına alır.
• Geliştirici deneyimi ekipleri, hangi sayfanın çok okunduğunu ve neyin arandığını izleyerek içeriği iyileştirir.
• Kurumsal yazılım üreticileri, kurulum ve entegrasyon rehberlerini müşterilerine düzenli bir yapıda sunar.
• Açık kaynak projeler, başlangıç rehberi ve kavram sayfalarını katkıcılar için ortak ve aranabilir bir sitede toplar.

• Dokümantasyon özeti kartları

  Panelin üstünde toplam sayfa ve taslak sayısı, aylık görüntülenme, sitede yapılan arama sorguları ve okuyucu oylarıyla faydalılık oranı yer alır. Her kartta değişim görünür.

• İçerik ağacı

  Sayfalar başlangıç, rehberler, API başvurusu ve dağıtım gibi bölümler altında sıralanır. Bölüm etiketleriyle ağaç süzülür, her sayfanın görüntülenme sayısı yanında yazar.

• Markdown editörü

  Sayfalar Markdown ile yazılır. Başlıklar, listeler, kod blokları ve bilgi kutusu bileşenleri metin içinde tanımlanır; teknik yazar biçimlendirmeyle uğraşmadan içeriğe odaklanır.

• Canlı önizleme

  Kaynak metnin yanında işlenmiş görünüm canlı olarak güncellenir. Yayına almadan önce sayfanın okuyucuya nasıl görüneceğini, başlık ve kutuların yerleşimini aynı ekranda kontrol edersiniz.

• Kod blokları

  Kod örnekleri dosya adı, dil etiketi, satır numarası ve sözdizimi renklendirmesiyle gösterilir. Geliştirici örneği okurken hangi dosyaya ait olduğunu hemen görür.

• Yayın durumu

  Her sayfa yayında, incelemede ya da taslak durumuyla izlenir. Sayfa yolu üst satırda görünür; yayınla düğmesiyle içerik canlıya alınır ve yayında etiketi eklenir.

• Yapay zekâ ile taslak

  Yapay zekâ ile taslak düğmesi yeni bir sayfa için başlangıç metni hazırlar. Taslak teknik yazar tarafından gözden geçirilir ve düzenlenmeden yayına alınmaz.

• Doküman araması

  Panel içindeki arama kutusu sayfalarda arama yapar ve kısayolla açılır. Okuyucuların sitede yaptığı arama sorgularının sayısı özet kartında ayrıca izlenir.

• Sayfalar ve analitik

  Sayfalar bölümünde tüm içerik listelenir, analitik bölümünde okunma verisi incelenir. API başvurusu, sürümler ve gelişmiş arama menüde yakında olarak görünür.

1. Kurulumda dokümantasyon sitenizin bölümleri ve alan adı belirlenir.
2. Teknik yazar yeni sayfa açar, Markdown ile yazar ya da yapay zekâ taslağından başlar.
3. Sayfa canlı önizlemede kontrol edilir ve incelemeye gönderilir.
4. Onaylanan sayfa yayınla düğmesiyle dokümantasyon sitesinde yayına alınır.
5. Görüntülenme, arama sorguları ve faydalılık oranı izlenerek sayfalar güncellenir.

Ekran görüntüleri örnek veriyle hazırlanmış tanıtım ekranlarıdır; görünen ad, logo ve rakamlar temsilidir. Kurulumda arayüz sizin markanızla düzenlenir.

• Dokümantasyon sitesi markanızın logosu, renkleri ve alt alan adıyla talebe göre yayına alınır.
• API başvurusu, sürüm yönetimi ve gelişmiş arama menüde yakında olarak görünür; bu modüllerin kapsamı görüşmede netleşir.
• Kod deposundan otomatik içerik çekme ya da API tanım dosyasından sayfa üretme ekranda hazır görünmez; talebe göre bağlanabilir.
• Mevcut dokümanlarınızın aktarımı ve bölüm yapısı ürününüze göre kurulumda planlanır.