Bilgi Ressamı

Geliştirici belgelerini kusursuz videolara dönüştürün

API belgelerini, changelogs, entegrasyon notları, mimari grafikleri ve diğer geliştiriciler belgelerini yüklemek için talep yollarını, sistem davranışını, sürüm değişikliklerini ve inceleme noktalarını gösteren videolar oluşturmak.

Ücretsiz başla

Sistem yolunu açıklamak için görsel bir dizi kullanın

kimin için

  • Geliştirici ilişkileri ekipleri

    Tüm belge setinde gezinmeden önce geliştiricilere yeni bir yönlendirme sağlayan bir açıklamaya ihtiyacınız var.

    • DevRel ekipleri
    • Geliştirici savunucuları
    Tipik belgeler :API dokümanlarMimari diyagramları

  • Ürün ve mühendislik ekipleri

    Bir sürüm veya entegrasyon değişikliğinin, sistemin farklı bölümlerine sahip kişiler arasında iletişim kurmanın daha kolay olmasını istiyorsunuz.

    • Ürün yöneticileri
    • Mühendislik ekipleri
    Tipik belgeler :Değişiklik GünlükleriEntegrasyon notları

Belgelerinizi hazırlayın

Zaten güvendiğiniz kaynakla başlayın

API belgeleri, mimari diyagramları, değişiklik günlükleri ve entegrasyon notları gibi geliştirici belgelerini, insanların takip edip tekrar ziyaret edebileceği videolara dönüştürün.

  • Geliştirici belgeleri
  • API belgeleri
  • Mimari diyagramları
  • Değişiklik Günlükleri
  • Entegrasyon notları

Başlamadan önce

  • Mevcut, tam kaynak versiyonunu kullanın
  • Dikkat etmeye değer bölümleri, adımları, grafikleri veya rakamları işaretleyin
  • Kalan kelimeleri, sayıları, uyarıları veya sözcükleri belirleyin

odaklanmış bir yol

Yalnızca uç nokta adlarını değil, yolu da açıklayın

  1. 1

    Görüntüleyenin sorusunu adlandırın

    Geliştiricinin amacını, anlaması gereken sistem ilişkisini ve önemli olan mevcut sürümü veya sınırı belirtin.

  2. 2

    Ayrıntıları taşıyan kaynağı getirin

    Geçerli kaynağı ekleyin ve açıklamanın koruması gereken bölümleri, terimleri, şekilleri veya adımları adlandırın.

  3. 3

    Kullanım bağlamına göre açıklamayı hassaslaştırın

    Paylaşmadan önce API veya ürün sahibinin terminolojiyi, örnek davranışı, sürüm referanslarını ve güvenlik açısından hassas sınırları doğrulamasını sağlayın.

Faydalı bir sonraki adım

Bu görevi karşılayan bir kaynak veya durum kullanın

Teknik bir yolu görünür kılmak için kaynak destekli bir komut dosyası kullanın

Teknik belgeler

Teknik Belgeleri Net Videolara Dönüştürün

Mimari kılavuzlarını, geliştirici belgelerini ve BT runbook'larını anlaşılır teknik açıklayıcı videolara dönüştürmeye yönelik pratik bir kılavuz.

Bu kaynağı kullanın Şablonlar ve kontrol listeleri

Karmaşık Süreç Açıklayıcı Komut Dosyası Şablonu

Bir süreci, kararı, grafiği veya teknik iş akışını net görsel kanıtlarla açıklamaya yönelik, kopyalanabilir 60 saniyelik bir komut dosyası şablonu.

Bu kaynağı kullanın BT operasyonları şablonu

BT Runbook'tan Video Şablonuna

Bir BT runbook'unu ilk kontrolü, yönlendirmeyi ve devretmeyi net hale getiren sakin, role özgü bir videoya dönüştürmek için kopyalanabilir bir şablon.

Bu kaynağı kullanın Kaynak desteklenen durumlar

Yayın mimarisi kılavuzunu geliştirici katılım videosuna dönüştürme

Bir mimari ve sürüm kılavuzunun; bileşenleri, sürüm akışını ve katkı bağlamını birbirine bağlayan bir geliştirici katılım videosuna nasıl dönüştüğünü görün.

Case Tasarımı Okunma Kaynak desteklenen durumlar

BT olayı runbook'unu sakin bir önceliklendirme videosuna dönüştürme

BT hizmeti düşüşü runbook'unun durum kontrollerini, üst kademeye yükseltme sahipliğini ve operasyon ekipleri için bir sonraki güncellemeyi gösteren sakin bir önceliklendirme videosuna dönüşmesini izleyin.

Case Tasarımı Okunma

FAQ

İlk açıklayıcı videonuzu oluşturun