Dokümantasyon ekipleri Markdown'ı genellikle birden fazla hedefe taşır: GitHub, CMS, changelog, help center veya ürün içi alanlar. Her hedef biraz farklı render edebilir. Bu yüzden yayın öncesi kontrol, sadece metni okumaktan ibaret olmamalıdır.
Markdown validator, GitHub-flavored önizleme ve yapısal uyarıları bir araya getirerek bu son kontrolü hızlandırır.
Hedef ortamı unutmayın
Markdown esnektir, ama bu esneklik sürpriz yaratır. GitHub'da çalışan bir tablo CMS'te farklı görünebilir. Raw HTML sanitize edilebilir. Code fence dili görünmezse örnekler daha zor okunabilir. Bu yüzden hedef ortamı bilerek kontrol yapmak gerekir.
Converty, hedef sistemin birebir render motoru değildir; ancak sorunlu yapıları yayın öncesinde yakalamak için hızlı bir ön inceleme sağlar.
Dokümantasyon kontrol listesi
| Kontrol | Neden önemli |
|---|---|
| Başlık sırası | Belge hiyerarşisi ve taranabilirlik |
| Tek H1 kullanımı | Sayfa başlığı ve içerik yapısı |
| Link hedefleri | Boş veya yanlış linkleri yakalama |
| Görsel alt metni | Erişilebilirlik ve kalite |
| Code fence dili | Okunabilirlik ve syntax highlighting |
| Raw HTML | Hedef ortamda güvenli render beklentisi |
Ekip akışı
- Taslak Markdown'ı araçta önizleyin.
- Uyarı listesini editoryal checklist gibi kullanın.
- Link anchor text'lerinin hedef locale route'larıyla uyumlu olduğunu kontrol edin.
- Raw HTML varsa sanitize edilmiş davranışı inceleyin.
- İçeriği GitHub veya CMS tarafında son kez doğrulayın.
Bu akış, dokümantasyon yazarları ve reviewer'lar arasında daha net bir ortak kontrol sağlar.
Kısa FAQ
Converty GitHub'ın birebir önizlemesi mi?
Hayır. GitHub-flavored Markdown desenlerini destekler, ancak hedef sistemde son kontrol yine gereklidir.
CMS için kullanabilir miyim?
Evet, yayın öncesi ön kontrol olarak kullanabilirsiniz. CMS'in kendi render davranışını ayrıca kontrol edin.
Uyarılar kesin hata mı?
Hayır. Uyarılar dikkat edilmesi gereken noktalardır. Ekip bağlamına göre karar verin.
Raw HTML güvenli şekilde gösterilir mi?
Önizleme raw HTML'i sanitize eder, bu da güvenli olmayan markup'ın etkisini azaltır.
Yayın öncesi son kontrolü hafif tutun
Dokümantasyon kalitesi, sadece doğru cümlelerden değil, doğru yapıdan da gelir. Converty, Markdown yapısını hızlıca görünür hale getirerek GitHub veya CMS yayınından önce daha net bir kontrol adımı sağlar.
Doğrudan başlamak için Markdown validator sayfasını açın; daha genel editoryal akış için Markdown sorunlarını yayınlamadan önce yakalama rehberine devam edin.
