Yazılım Belgeleri: Daha İyi Hale Getirmenin 5 Kolay Yolu

Çoğu insan yazılım kullanıcı belgelerini düşündüğünde, muhtemelen heyecan verici, ilgi çekici veya eğlenceli bir şey hayal etmezler. Bunun nedeni, çok sayıda yazılım kullanıcı kılavuzunun, hızlı başlangıç ​​kılavuzunun, öğreticinin ve benzerinin, son kullanıcının bunlardan ne elde edeceği konusunda çok az düşünülen büyük metin blokları tarafından domine edilmesidir.

Daha iyi bir yol var.

En iyi kullanıcı belgeleri, müşterilerinize yazılımınızı büyük, sindirimi zor bölümlerde nasıl kullanacaklarını söylemez. Onlara, başarılı olmalarına yardımcı olacak görevleri tam olarak nasıl gerçekleştireceklerini basit terimlerle net bir şekilde özetleyen küçük parçalar halinde görseller ve video ile nasıl yapılacağını gösterir.

Ve hepsinden iyisi, düşündüğünüzden ÇOK daha kolay. Müşterilerinizi memnun edecek ve ürünlerinizde daha başarılı olmalarına yardımcı olacak görseller ve videolarla yazılım belgelerinizi geliştirmenin beş basit yolunu göstereceğim.

İşte öğrenecekleriniz:

• Neden görseller ve videolar öğretmek ve öğrenmek için daha iyi bir yol sunar?
• Yardım içeriğinizi geliştirmek için ekran görüntülerini nasıl kullanabilirsiniz.
• Neden basitleştirilmiş grafikler müşterileriniz için netlik katar ve kullanıcı belgelerinizin ömrünü uzatır?
• Ekran görüntülerinizi video eğitimlerine dönüştürmek, içeriğinize nasıl yeni bir boyut katar?
• PDF'ler neden yazılım belgeleriniz için en iyi seçenek olmayabilir?

Görsel yazılım dokümantasyonu neden daha iyidir?

Görsellerin Değeri araştırmamızı yaptığımızda, insanların yalnızca metin yerine görsel içerik sunulduğunda daha iyi öğrendiklerini keşfetmeyi umduk. Ancak görsel içeriğin ne derece fark yarattığını beklemiyorduk.

İnsanların yaklaşık %70'i yalnızca metin yerine görsel yönergeleri tercih etmekle kalmıyor, aynı zamanda daha hızlı öğreniyor, görevleri daha doğru bir şekilde yerine getiriyor ve bilgileri daha uzun süre akılda tutuyor. Dürüst olmak gerekirse oldukça akıllara durgunluk veriyordu.

Ve en son Video Görüntüleyici Çalışması analizimiz, giderek daha fazla insanın huysuz eski bir PDF veya metin ağırlıklı web sayfası yerine video aracılığıyla yardım veya nasıl yapılır içeriği aradığını buldu.

Sonuç olarak, insanlar sadece görselleri ve videoları tercih etmiyorlar (yapıyorlar!), ayrıca bunlardan daha fazlasını alıyorlar.

Bu, daha mutlu, daha başarılı müşterileriniz olacağı ve teknik destek personelinize yapılan aramaları, e-postaları ve diğer soruları azaltacağınız anlamına gelir.

Yazılım belgeleri görseller ve videolarla nasıl geliştirilir

Bu nedenle, görseller ve videolar, herhangi bir iyi yazılım belgelendirme stratejisinin önemli bir bileşenidir, ancak özellikle çok az deneyiminiz varsa veya hiç deneyiminiz yoksa, bu tür içerik oluşturmayı düşünmek de göz korkutucu olabilir.

Olması gerekmiyor. Daha önce hiç oluşturmamış olsanız bile, yüksek kaliteli görseller ve videolar oluşturmak inanılmaz derecede kolay olabilir.

İşte yazılım belgelerinizi görsellerle iyileştirmenin beş kolay yolu.

1. Ekran görüntülerini kullanın

Ekran görüntüleri, yazılımınızın kullanıcı arabiriminin görüntülerini belgelerinize eklemenin en basit yollarından biridir.

Düz bir ekran görüntüsü bile, yazılımınızda veya web sitenizde gezinmeye çalışan kullanıcılarınıza çok yardımcı olabilir, ancak ek açıklamalar ve açıklamalarla zenginleştirildiğinde, bunlar önemli ve anlaşılması kolay bir araç haline gelir.

Bir resim 1.000 kelimeye bedelse, iyi bir ekran görüntüsü 10.000 kelimeye bedel olmalıdır.

Ücretsiz ekran görüntüsü araçları mevcut olsa da TechSmith Snagit gibi daha güçlü ve çok yönlü bir seçenek, yüksek kaliteli görüntüler oluşturmayı daha da kolaylaştırır. Ekranın istediğiniz kadar çoğunu veya azını gösterebilirsiniz ve Snagit'in kolay açıklamaları ve açıklamaları, önemli öğeleri vurgulayabileceğiniz veya kullanıcılarınızın dikkatini en hayati olana çekebileceğiniz anlamına gelir.

Bir dizi ekran görüntüsü, bir görevi tamamlama adımlarını gösterebilir veya Snagit'in adım aracı hepsini tek bir görüntüde gösterebilir.

Etkili ekran görüntülerini nasıl oluşturacağınızı öğrenin

2. Basitleştirilmiş grafikler kullanın

Birçok yazılım arayüzü karmaşık olabilir ve bir dizi seçenek sunar. Ve çoğu zaman bir süreci veya nasıl yapılır göstermek istediğinizde, tamamını göstermeniz gerekmez. Aslında, bazen tüm arayüzü göstermek kafa karıştırıcı olabilir.

Basitleştirilmiş grafikler, ekran görüntünüzün önemsiz kısımlarını vurgulamanıza ve kullanıcılarınızın görmesi gerekenleri vurgulamaya yardımcı olur.

Snagit ile basitleştirilmiş grafikler oluşturmak hiç bu kadar kolay olmamıştı. Sadece Basitleştirme aracını seçin ve Otomatik Basitleştir seçiliyken gerisini Snagit halleder. Snagit'in ne kadar ayrıntı göstermesini istediğinizi seçebilir ve ihtiyacınız olmayan basitleştirmeleri kaldırabilirsiniz.

Daha hassas kontrol için sadeleştirmeyi manuel olarak uygulamayı da seçebilirsiniz.

Nasıl yaparsanız yapın, basitleştirilmiş grafikler, kullanıcılarınızın dikkatlerini tam olarak nereye odaklamaları gerektiğini anlamalarına yardımcı olur.

3. Ekran görüntülerinizi videoya dönüştürün

Görüntüler, yazılım belgelerinizi geliştirmenin güçlü ve kullanışlı bir yolu olsa da videolar, karışıma hareket ve sesli talimatlar ekleyerek bunu daha da ileri götürebilir.

Şimdi, daha önce hiç video çekmediyseniz, başlama düşüncesi inanılmaz derecede göz korkutucu olabilir. Ancak çok az video deneyimiyle veya hiç video deneyimi olmadan son derece etkili videolar oluşturabilirsiniz. Aslında, bir ekran görüntüsü alabiliyorsanız, yoldasınız demektir!

Bir kez daha, kurtarmaya gelen Snagit. Snagit, bir dizi ekran görüntüsü almanıza ve bunları yazılım belgelerinizin, yardım içeriğinizin ve daha fazlasının bir parçası olarak paylaşabileceğiniz hızlı bir videoya dönüştürmenize olanak tanır. Aslında, teknik destek ekibinizin kullanıcılara bir sorunu nasıl çözeceklerini göstermesi için harika bir yoldur.

Ekran görüntülerinizi alabilir ve ardından Snagit'in Görüntülerden Video işlevini kullanarak videonuzu yapabilir veya ekran görüntülerinizi alabilirsiniz. Ancak bunu yaparsanız, ilerledikçe ses ve ek açıklamalar ekleyebilirsiniz.

4. Bir video kaydedin

Ekran görüntüleri sayamayacağım kadar çok açıdan harika ve kullanışlı. Ancak bazen videodan başka hiçbir şey işe yaramaz.

Görüntülerdeki bir videodan farklı olarak, ekran kaydı ekranınızın ve gerçekleştirdiğiniz fare hareketlerinin, tıklamaların vb. videosunu çeker.

Snagit'in yerleşik ekran kaydedicisi, eklemek istediğiniz herhangi bir seslendirmenin yanı sıra ekranınızın tamamını veya bir kısmını yakalamanıza olanak tanır. Bazı ekstra kişilik için kameranızı da ekleyebilirsiniz.

Bazen bu kişisel dokunuş, kullanıcılarınızın yazılımınızı öğrenme konusunda daha az stresli hissetmelerine yardımcı olmak için uzun bir yol kat eder.

Yine de, en iyi videoların öğretmek istediğiniz şeyi göstermek için mümkün olduğunca kısa olduğunu unutmayın. Her özelliğin nasıl kullanılacağını tek bir videoda göstermeye çalışmayın.

5. PDF'lerin ötesinde düşünün

Adobe'nin Taşınabilir Belge Formatı (PDF), bilgileri paylaşma şeklimizi değiştirdi. Birinin belgelerinizin mükemmel biçimde biçimlendirilmiş bir kopyasını indirip yazdırabilmesini istediğiniz zamanlar için mükemmeldirler.

Ama kabul edelim, en son ne zaman yazılım belgelerini indirip yazdırdınız?

Web ile ilgili en iyi şeylerden biri, bilgileri yazdırmaya gerek kalmadan paylaşabilmemizdir. Kullanıcıları bir PDF'ye erişmeye zorlamak yerine, yazılım belgelerinizi web sitenizdeki sayfalarda tutun. Çok daha fazla seçeneğiniz olacak (videoları dahil edebilmek dahil) ve çoğunlukla web sayfalarını güncellemek PDF belgelerine göre çok daha kolay, bu da kullanıcılarınızın her zaman en güncel bilgilere sahip olmasını sağlıyor.

Ve PDF'lerin aksine, web sayfalarınız yüksek oranda aranabilirdir, yani kullanıcılarınızdan biri ürününüz hakkında bilgi istediğinde içeriğinizi bulma olasılıkları daha yüksektir.

Web içeriğine ek olarak her zaman bir PDF sunabilirsiniz, ancak PDF'leri insanların yazılım belgelerinizi alabilmelerinin TEK yolu haline getirmeyin.

Ve hey, videolarınızı YouTube gibi sitelere de koyabileceğinizi unutmayın!

Daha iyi yazılım belgeleri = daha mutlu kullanıcılar

Metin ağırlıklı yazılım belgeleri oluşturmaya devam edebilir ve müşterilerinizi bu belgede gezinmeye zorlayabilirsiniz veya onlara istediklerini VE ürünlerinizi daha hızlı ve daha verimli kullanmalarına yardımcı olan şeyleri verebilirsiniz.

Belgelerinize daha fazla görsel ve video ekleyerek müşterilerinize daha iyi hizmet verebilirsiniz.

Ve Snagit ile, kelimenin tam anlamıyla herkes, müşterilerinizi memnun edecek, çağrıları ve e-postaları teknik desteğe indirecek ve ömür boyu kullanıcılar oluşturmaya yardımcı olacak inanılmaz derecede profesyonel görünümlü görseller ve videolar oluşturabilir.