Teknik Yazarlar için Ekran Kaydı Rehberi

Statik ekran görüntüleri ve metin duvarlarının yapabilecekleri sınırlıdır. Kullanıcılar uzun paragrafları atlar, açıklamaları yanlış anlar ve numaralı listelere gömülü kritik adımları kaçırır. Ekran kayıtları, tam olarak ne yapılması gerektiğini sırayla ve belirsizlik olmadan göstererek bu sorunları çözer.

Bu rehber, teknik yazarların destek yükünü azaltan ve ürün benimsenmesini iyileştiren belge kalitesinde videolar üretmek için Recorded’ı nasıl kullanabileceğini açıklar.

Videonun Teknik Belgelere Neden Dahil Edilmesi Gerekir

Metin tabanlı belgeler referans materyaller için iyi çalışır — API referansları, yapılandırma seçenekleri, kavramsal açıklamalar. Ancak prosedürel içerik için (“X’i nasıl yapabilirim?”) video genellikle daha hızlı anlaşılır ve yanlış yorumlanması daha zordur.

Teknik yazarlar için temel faydalar:

• Daha az belirsizlik: İzleyiciler açıklanan bir tahmini değil, tam UI durumunu görür
• Daha az destek talebi: Bir videoyu takip edebilen kullanıcılar nadiren aynı görev için bilet açar
• Daha hızlı katılım: Yeni kullanıcılar karmaşık iş akışlarını rehber olmadan öğrenir
• Dilden bağımsız: İyi yapılmış bir video, çevrilmiş metinden daha iyi dil engellerini aşar

Kayıt Oturumunuzu Planlamak

İyi belgeleme videoları, kayıt düğmesine basmadan önce başlar.

Önce Adımları Senaryolaştırın

Numaralı bir prosedür yazıyormuş gibi her adımı yazın. Bu sizin kayıt senaryonuz olur. Bir adım yazmak zorsa, kaydetmek de zor olacaktır — bunu yaklaşımınızı basitleştirmek için bir sinyal olarak kullanın.

Doğru Yakalama Modunu Seçin

• Pencere yakalama: Çoğu belgeleme çalışması için bunu kullanın. Uygulamayı masaüstü karmaşasından izole eder ve izleyicilere temiz, odaklı bir görünüm sunar.
• Tam ekran: Birden fazla uygulama veya sistem düzeyindeki etkileşimler arasında bağlamı göstermeniz gerektiğinde uygundur.
• Özel alan: Daha büyük bir uygulama içindeki belirli bir panel veya widget’ı yakalamak için kullanışlıdır.

Ne Söyleyeceğinize ve Ne Göstereceğinize Karar Verin

Her şeyin seslendirmeye ihtiyacı yoktur. Bazı eylemler ekranda kendini açıklar. Seslendirmenizi neden’in bağlamını eklemek için planlayın, video ise nasıl’ı göstersin.

Belgeleme için Kayıt Ayarları

Belge kalitesinde kayıtlar için bu ayarları kullanın:

• Çözünürlük: Yerel ekran çözünürlüğünde yakalayın. Gerekirse dışa aktarımda küçültün.
• Kare hızı: 30 fps idealdir — dosya boyutunu şişirmeden UI etkileşimleri için yeterince akıcı.
• İmleç görünürlüğü: İmleci her zaman görünür tutun. İzleyicilerin nereye tıkladığınızı takip etmeleri gerekir.
• Sistem sesi: İlgili değilse devre dışı bırakın. Bildirim sesleri ve arka plan gürültüsü seslendirmeyi etkiler.

Etkili Şekilde Yakalamak

Karmaşık Eylemlerde Yavaşlayın

İmleci bilinçli olarak hareket ettirin, özellikle sürükle bırak, klavye kısayolları veya bağlam menüleri gibi çok adımlı etkileşimler gerçekleştirirken. Kayıt sırasında yavaş hissettiren şey oynatma sırasında doğal görünür.

Önemli Eylemlerden Önce Durun

Her önemli eylemden önce yarım saniyelik bir duraklama, izleyicilere bir şey değişmeden önce yönlenmelerine zaman tanır. Bu, özellikle klavye kısayolları için kullanışlıdır; çünkü orada görünür bir UI işareti yoktur.

Odaklanmak için Pencere Yakalamayı Kullanın

Yalnızca uygulama penceresini yakalamak belgelerinizi temiz tutar. İzleyiciler masaüstünüzden, diğer açık pencerelerden veya tarayıcı sekmelerinden dikkat dağıtılmaz.

Belgeleme için Düzenleme

Agresif Şekilde Kırpın

Belgeleme videoları mümkün olduğunca kısa olmalıdır. Şunları kaldırın:

• UI’nin yanıt vermesini beklerken uzun duraklamalar
• İlgili alandan uzaklaştığınız anlar
• Bir eylemin tekrarlanan denemeleri

Küçük UI Öğelerine Yakınlaştırma Efektleri Ekleyin

Birçok belgeleme senaryosu küçük düğmeler, simgeler veya metin alanları içerir. Etkileşim anında izleyicileri yakına çekmek için Recorded’ın yakınlaştırma efektlerini kullanın — sonra sonucu göstermek için uzaklaştırın.

Belgeleme yakınlaştırmaları için en iyi uygulamalar:

• Tıklamadan önce yakınlaştırın, sonra değil
• İzleyicilerin etiketleri veya metni okuyabilmesi için yakınlaştırmayı yeterince uzun tutun
• Eylemin tam sonucunu göstermek için normal görünüme dönün

İmleç Vurgularını Kullanın

Tıklama noktalarını belirgin hale getirmek için imleç vurgularını etkinleştirin. Tıklamada görsel bir nabız, neyin seçildiğine dair her türlü şüpheyi giderir. Bu, yoğun arayüzlerdeki eylemler için özellikle kullanışlıdır.

Her Videoyu Tek Bir Göreve Odaklayın

Birden fazla prosedürü uzun bir videoda birleştirme cazibesine karşı koyun. Kısa, göreve odaklı videolar ürün UI’si değiştiğinde bulmak, paylaşmak ve bakımını yapmak için daha kolaydır.

Videoları Belgelerinize Entegre Etme

Video ile Yazılı Adımları Eşleştirin

Video ve metin birbirini tamamlar. Taramayı tercih eden kullanıcılar için belgelerinizde yazılı adımları saklayın. İzlemeyi tercih eden kullanıcılar için prosedürün hemen üstüne veya altına videoyu ekleyin.

Açıklayıcı Dosya Adları ve Başlıklar Kullanın

Video dosyalarını ve gömülü başlıkları belirli görevi yansıtacak şekilde adlandırın: tutorial-video-3.mp4 değil, create-api-key.mp4. Bu, belgeleme kitaplığınızı ölçekte bakımı yapılabilir kılar.

Belgeleme Siteleri için Dışa Aktarma Formatı

Belgeleme platformlarına (Confluence, Notion, GitBook, ReadMe) gömmek için:

• MP4 (H.264): Platformlar ve tarayıcılar arasında en iyi uyumluluk
• Çözünürlük: İçerik yoğunluğuna bağlı olarak 1280×720 veya 1920×1080
• Dosya boyutu: Mümkün olduğunca video başına 50 MB altında tutun — büyük dosyalar sayfa yüklemesini yavaşlatır

Bir Video Kütüphanesi Oluşturun

Tüm belgeleme videolarınızın yapılandırılmış bir klasörünü kaynak dosyalarınızın yanında bulundurun. Bu, ürün UI değişikliklerini piyasaya sürdüğünde güncel olmayan içeriği tanımlamayı ve yeniden kaydetmeyi kolaylaştırır.

Bakım: Videoları Güncel Tutmak

Belgeleme videoları belirli bir ömre sahiptir. UI güncellemeleri, yazılı içerikten daha hızlı eskir. Bunu azaltmak için:

• Büyük UI sürümlerinde yeniden kaydedin: Değişen gezinmeyi veya yeniden tasarlanmış ekranları gösteren videoları önceliklendirin
• Video açıklamalarına “son doğrulama” tarihi ekleyin: Kullanıcılara içeriğin ne kadar güncel olduğunu gösterir
• Kayıtları kısa tutun: Kısa videolar, uzun rehberlerden daha ucuza yeniden kaydedilebilir

Belgeleme Videosu Kontrol Listesi

Herhangi bir belgeleme kaydını yayınlamadan önce:

• Tüm adımlar görünür ve net sıralı
• İmleç her zaman görünür
• Küçük veya kritik UI öğelerine yakınlaştırma efektleri uygulandı
• Gereksiz duraklamalar kaldırıldı
• Ses net ve arka plan gürültüsünden arındırılmış
• Video süresi görevin izin verdiği kadar kısa
• Uygun çözünürlükte MP4 formatında dışa aktarıldı
• Video, belgede yazılı adımlarla eşleştirildi

Sonuç

Ekran kayıtları, teknik yazarların araç kutusunda en az kullanılan araçlardan biridir. İyi yazılmış prosedürlerle birlikte kullanıldığında belirsizliği azaltır, kullanıcı güvenini artırır ve kapsadıkları görevler için destek hacmini düşürür.

En sık sorulan destek sorularınızla başlayın — kullanıcıların en sık dile getirdiği sorunlar, net ve odaklı bir kaydın en büyük etkiyi yaratacağı yerdir.