Video mu, yazılı doküman mı: Ne zaman kaydetmeli, ne zaman yazmalı

Her ekip er ya da geç aynı tartışmaya düşer. Biri “kısa bir video çek yeter” der, bir başkası “bu bir doküman olmalı” der ve iki taraf bir karar beklerken iş bir hafta boyunca olduğu yerde kalır.

Cevap, formatlardan birinin daha iyi olması değil. Video ile metin farklı yerlerde başarısız olur. Hareketi, sırayı ve muhakemeyi göstermekte video rakipsizdir. Göz gezdirilmek, aranmak ve düzeltilmek konusunda metin rakipsizdir. Yanlış seçerseniz ya iki satırlık bir cevabı sekiz dakikalık bir kaydın içine gömersiniz ya da bir sürükle bırak hareketini yazıyla anlatmak için bütün öğleden sonranızı harcarsınız.

Bu rehber, başlamadan önce yaklaşık otuz saniyede karar vermenizi sağlayan, tekrarlanabilir bir yöntem sunuyor.

Otuz saniyelik test

Belgelemek istediğiniz şey hakkında üç soru sorun.

1. Hareket ediyor mu? Anlamak için bir şeyin olup bittiğini izlemek gerekiyorsa — imleç yolu, durum geçişi, animasyon, gerçek zamanlı tepki veren bir araç — kaydedin.
2. İleride biri yalnızca belirli bir parçasına ihtiyaç duyacak mı? İnsanlar tek bir değere, ayara ya da adıma bakmak için geri dönecekse yazın. Kimse bir port numarasını bulmak için zaman çizelgesinde ileri geri gezinmez.
3. Ne sıklıkta değişiyor? Ekran her ay değişiyorsa metnin bakımı daha ucuzdur. Bir yıl sabit kalıyorsa video kendini amorti eder.

İki “video” cevabı kaydetmek demektir. İki “metin” cevabı yazmak demektir. Berabere kalıyorsa muhtemelen ikisine de ihtiyacınız var — ki bu kulağa geldiğinden daha kolay.

Videonun kazandığı durumlar

Araçlar arasında geçen bir iş akışını göstermek. Çoğu sürecin zor kısmı tek bir tıklama değil, uygulamalar arasında ne olduğudur. Bir kayıt, altı bağlam değişimini anlatmanıza gerek kalmadan tüm yolu yakalar.

Görsel muhakeme gerektiren her şey. “Boşluklar daha dengeli dursun”, “bu animasyon fazla hızlı”, “grafik daha çok nefes almalı”. Bunları metinle tam olarak tarif etmek imkânsız, on saniyelik videoda ise apaçık.

Hata raporları ve yeniden üretme adımları. Kayıt; tam sırayı, tam zamanlamayı ve tam durumu gösterir. “Bende olmuyor” gidip gelmelerini tamamen ortadan kaldırır.

İşe alıştırma ve ilk izlenimler. Yeni ekip arkadaşlarının, ustalığın nasıl göründüğünü görmesi gerekir: bir iş ne kadar sürmeli, deneyimli biri nerede duraksıyor, neleri görmezden geliyor. Yazılı adımlar bunların hepsini düzleştirir.

Aksi hâlde canlı olarak üç kez anlatacağınız her şey. Aynı şeyi üç toplantıda söylediyseniz gereken şey dördüncü bir toplantı değil, bir kayıttır.

Tonu aktarmak. Geri bildirimler, nüans içeren kararlar ve sert algılanabilecek her şey, ses ve yüz eşlik ettiğinde çok daha iyi karşılanır.

Yazının kazandığı durumlar

Referans içerik. Yapılandırma değerleri, API parametreleri, klavye kısayolları, hata kodları. Öğrenilmekten çok bakılan her şey.

Aranabilir olması gereken her şey. Metin; wiki’niz, yardım merkeziniz ve arama motorları tarafından indekslenir. Altyazı eklemediğiniz sürece video bir kara kutudur.

Sık değişen adımlar. Bir dokümandaki tek satırı düzenlemek saniyeler sürer. Bir bölümü yeniden kaydetmek, sesi uydurmak ve yeniden dışa aktarmak bir saat sürer — üstelik eskimiş her kare, tüm kütüphaneye duyulan güveni zedeler.

İş yapılırken bakılan içerik. Kimse bir eliyle migration çalıştırırken diğer eliyle videoyu durdurup geri sarmak istemez. Kontrol listeleri okunmak içindir.

Hukuk, uyum ve tam ifade gerektiren her şey. Netlikten çok kesinlik önemliyse yazın, gözden geçirtin ve sürümleyin.

Çeviri yükü yüksek içerik. Metin on dört dile ucuza çevrilir. Seslendirmeyi yeniden kaydetmek öyle değil.

Çoğu ekibin aslında ihtiyaç duyduğu format

En iyi dokümantasyon nadiren ikisinden biridir. Yazılı bir omurgaya sahip kısa bir kayıttır.

Güvenilir bir kalıp:

• Doğruluk kaynağı olarak yazılı bir sayfa. Başlık, amaç, ön koşullar, numaralı adımlar ve kopyalanabilir metin hâlinde tüm kesin değerler.
• Üst tarafa gömülü iki-dört dakikalık bir kayıt. İşin genel şeklini gösterir, okuyan kişi neyle karşılaşacağını bilir.
• Bölüm işaretleri ve zaman damgaları, böylece video doğrusal olmaktan çıkıp gezinilebilir hâle gelir.
• Bir deşifre metni veya altyazı, böylece içerik aranabilir ve erişilebilir olur.

Genel fikri isteyen izler, bir değeri arayan göz gezdirir. Hiçbir grup diğerinin tercihi yüzünden cezalandırılmaz.

Kayıtları güncel kalabilecek kadar kısa tutun

Video dokümantasyonun çürümesinin bir numaralı nedeni uzunluktur. Sekiz konuyu kapsayan yirmi dakikalık bir kayıt, tek bir konu değiştiğinde baştan çekilmek zorundadır. Üç dakikalık sekiz kayıt ise teker teker değiştirilebilir.

Bir video kütüphanesini sürdürülebilir kılan pratik kurallar:

• Bir video, bir sonuç. Başlıkta “ve” gerekiyorsa bölün.
• Beş dakikanın altını hedefleyin. Çoğu süreç anlatımı üç dakikaya sığar.
• En hızlı değişen kısımları kaydetmeyin. Fiyatlar, tarihler, ekip adları ve arayüz metinleri videonun yanındaki metne aittir.
• Sürümü sesli söyleyin ya da ekrana koyun. “Bu kayıt 4.2 sürümünde alındı” cümlesi, eskimiş bir videoyu tarihi belli bir videoya dönüştürür; bu çok daha az zararlıdır.
• Temiz kaydedin. Rahatsız Etmeyin açık, gerçek müşteri kayıtları yerine demo verisi, tutarlı tek bir tema. Üç yerde yeniden kullanabileceğiniz bir klip, kullanamayacağınız üç klipten değerlidir.

Kayıt almanın maliyetini düşürün

“Bunu yazsak daha iyi” kararlarının çoğu aslında “kayıt almak bir prodüksiyon gibi geliyor” demektir. Bu maliyeti düşürmek tüm ekibin hesabını değiştirir.

• Girişi atlayın. Doğrudan önemli ekrandan başlayın. İç dokümantasyonun on beş saniyelik bir girizgâha ihtiyacı yok.
• Kelimesi kelimesine senaryo yazmayın. Beş madde yazın ve onların üzerinden konuşun. Senaryolar insanı okuyormuş gibi gösterir ve hazırlık süresini üçe katlar.
• Sorunları yeniden çekerek değil keserek çözün. Sessizlikleri, takılan cümleyi ve uzun yükleme süresini kırpın. Neredeyse her çekim kurtarılabilir.
• Anlatım yerine yakınlaştırma kullanın. Tıkladığınız düğmeye yapılan bir yakınlaştırma, o düğmenin nerede olduğunu anlatan cümlenin yerini alır.
• İyi bir çekim yeterlidir. İç dokümantasyonun dördüncü denemeye ihtiyacı yok. Yayınlayın.

Basit bir ekip politikası

Bu tartışmayı bitirmek istiyorsanız dört satır yazın:

1. Referans ve yapılandırma → metin. Her zaman.
2. İş akışları, demolar ve geri bildirim → video. Beş dakikanın altında.
3. İş sırasında kullanılan her şey → yazılı kontrol listesi, isteğe bağlı video özetiyle.
4. Üç ayda birden sık değişen her şey → metin, görselin kendisi asıl mesele değilse.

Sonra diğer dördünden daha önemli bir kural ekleyin: her videonun yazılı bir başlığı, tek cümlelik bir özeti ve ilgili dokümandan bir bağlantısı olur. Kimsenin bulamadığı bir kayıt, hiç alınmamış bir kayıttır.

Kapanış düşüncesi

Format seçmek bir üslup tercihi değildir; altı ay sonra işinizi okuyacak herkes adına verdiğiniz bir bakım kararıdır. Video anlamayı satın alır, metin kalıcılığı. En iyi dokümantasyona sahip ekipler bir tarafı seçenler değildir. Tartışmayı bırakıp izlenmeye değer olanı kaydeden, bakılmaya değer olanı yazan ve ikisini birbirine bağlayanlardır.