Doctave
Doctave, ekiplerin basit bir Git tabanlı iş akışı kullanarak teknik dokümantasyon oluşturmasına, yönetmesine ve yayınlamasına olanak tanıyan bir dokümantasyon platformudur.
Doctave nedir?
Doctave, Markdown ile yazma esnekliğini profesyonel dokümantasyon barındırma gücüyle birleştiren bir dokümantasyon platformudur. Dokümantasyonunuzu düz metin dosyalarında yazarsınız, kodunuzla birlikte Git'te depolarsınız ve Doctave bunları güzel, aranabilir dokümantasyon web sitelerine dönüştürür.
Platform, hem standart Markdown rehberlerini hem de API dokümantasyonu için OpenAPI spesifikasyonlarını destekler. Değişiklik yaptığınızda otomatik olarak önizleme ortamları oluşturur, böylece ekibiniz güncellemeleri yayınlamadan önce inceleyebilir. Her şey Git deposunda kalır, böylece dokümantasyonunuz üzerinde tam sürüm kontrolü sağlarsınız.
Doctave Studio, gerçek zamanlı önizlemeler, otomatik tamamlama önerileri, bozuk bağlantı kontrolü ve yazım denetimi sağlayan yardımcı masaüstü uygulamasıdır. Bu araçlar birlikte, ekiplerin güncel ve doğru dokümantasyon oluşturmasına yardımcı olur.
Doctave nasıl kullanılır
Doctave ile başlaması oldukça basittir. İşte etkili kullanımı:
Kod deposunda bir dokümantasyon klasörü oluşturun ve içeriğinizi Markdown dosyaları kullanarak yazın. Başlangıç sayfanız olarak bir README.md dosyası ekleyin.
Dokümantasyonunuzu yerel olarak gerçek zamanlı güncellemelerle önizlemek için bilgisayarınıza Doctave Studio'yu kurun.
Dokümantasyon yapınızı, tema renklerinizi ve gezinme bağlantılarınızı tanımlamak için doctave.yml yapılandırma dosyanızı ayarlayın.
Git deponuzu Doctave platformuna bağlayın. Her değişiklik gönderdiğinizde, Doctave yayınlanmış dokümantasyonunuzu otomatik olarak günceller.
API dokümantasyonu için OpenAPI spesifikasyon dosyanızı deponuza ekleyin. Doctave otomatik olarak etkileşimli API referans sayfaları oluşturacaktır.
Dokümantasyonunuzun farklı sürümlerini yönetmek için Git dallarını kullanın. Yayınlamadan önce değişiklikleri gözden geçirmek için çekme istekleri oluşturun ve Doctave her çekme isteği için önizleme bağlantıları oluşturacaktır.
Doctave özellikleri
Sürüm kontrolü ile Git tabanlı dokümantasyon iş akışı
Gerçek zamanlı önizlemeli Doctave Studio masaüstü editörü
API dokümantasyonu için OpenAPI spesifikasyon desteği
Pull requestler için otomatik önizleme ortamları
Çok sürümlü dokümantasyon yönetimi
Tüm içeriklerde yerleşik arama
Özel marka ve tema seçenekleri
Okuyucu analitiği ve geri bildirim toplama
Otomatik dağıtım için CI/CD entegrasyonu
Parola korumalı dokümantasyon seçenekleri
Doctave fiyatlandırması
Startup
$99 /ay
- Sınırsız proje
- 1 özel alan adı
- 5 kullanıcı dahil
- Git tabanlı iş akışı
- OpenAPI desteği
- Önizleme ortamları
- Yerleşik arama
- Analitik ve geri bildirim
- Özel marka oluşturma
Growth
$399 /ay
- Sınırsız proje
- 5 özel alan adı
- 10 kullanıcı dahil
- Tüm Startup özellikleri
- Gelişmiş işbirliği araçları
- Öncelikli destek
- Gelişmiş sürüm kontrolü
- Parola korumalı belgeler
Scale
$1000 /ay
- Sınırsız proje
- Sınırsız özel alan adı
- 25 kullanıcı dahil
- Tüm Büyüme özellikleri
- Kurumsal düzeyde güvenlik
- Özel destek
- Özel entegrasyonlar
- SLA garantileri
- Gelişmiş analizler
Migration Service
$500 bir kez
- Profesyonel içerik taşıma
- Organizasyonu ve formatlamayı korur
- Hizmet kesintisi yok
- Özel ekip eğitimi
- Kurulum yardımı
- Tek seferlik proje ücreti
Doctave kullanım durumları
Doctave'den kimler yararlanabilir?
Doctave hakkında sık sorulan sorular
Doctave ile deneyiminizi paylaşın
Kullanıcıların ne dediğini görün Doctave
0 İncelemeler
Henüz inceleme yok
İlk incelemeyi siz yapın Doctave
Doctave rozetlerini gömme
Topluluğunuza Doctave'in Tool Questor'de öne çıkarıldığını gösterin. Web sitenize, belgelerinize veya sosyal profillerinize bu güzel rozetleri ekleyerek güvenilirliği artırın ve daha fazla trafik çekin.
