Son Kullanıcı dokümantasyon örnekleri ve tavsiye için iyi referanslar [kapalı]

Şirket içi yazılımımız birçok kullanıcı için kullanılmıştır ve eğitim departmanı son kullanıcı dokümantasyon formatı için herhangi bir ipucu istedi.

İlham almak için bir eğitim departmanının kullanacağı yazılım son kullanıcı belgelerine veya iyi tavsiyeye sahip sitelere ilişkin iyi örnekleri nerede bulabilir miyim?

Bu, bu soruya benzer ancak teknik olmayan kullanıcılar tarafından kullanılan son kullanıcı belgelerini arıyorum.

Şirket içi kullanıcılarınızla yazılım hakkında röportaj yaparak başlamak isteyebilirsiniz ve ne tür bilgileri bilmek istediklerini öğrenebilirsiniz.

Yazılım hakkında yazdığım belgelerin çoğunda bir veya daha fazla izleyici göz önünde bulunduruldu. Eğitim bölümünüz muhtemelen bir başlıktan (TOC gibi) faydalanacaktır. Böylece hangi konuların ve neyin eğitim hedefleri ile ilgisiz olduğunu tartışabilirsiniz.

Bazı konular şunları içerebilir:

1. Hedef Kitle (ler)
2. Teknik gereksinimler
3. Nasıl Kurulur (varsa)
4. Süreç (yani yazılım hangi iş işlevini yerine getirir?)
5. Özellik seti (yazılımın hangi özellikleri var?)
   • Buna göre görev tabanlı bir yaklaşımınız olabilir, örn. Kullanıcı Ekleme veya Belge Ekleme
   • Nesne tabanlı bir yaklaşımınız olabilir, örneğin Kullanıcılar, Roller
   • Menü tabanlı bir yaklaşımınız olabilir, örn. Dosya menüsü, Görünüm Menüsü
6. Son olarak, muhtemelen Yaklaşan özellikler ve SSS bölümü, ürününüzün büyüyen bir bilgi deposu olarak işlev görebilir.

Son kullanıcılarınızın yazılımınızı nasıl kullandığını, onu geliştirme bilginize, ne yaptığına dair bilginize ve son kullanıcılarla yaptığınız görüşmelere (umarım) dayalı olarak tahmin etmeye çalışın.

En önemlisi, okumak istediğiniz belgeleri oluşturmaya çalışın, göstermek için eğlenceli örnek adları kullanın ve çok sayıda ek açıklamalı ekran görüntüsü kullanın.

Bu yardımcı olur umarım

Birkaç "Son Kullanıcı kılavuzu" okudum ve bir tane yazdım ve bunların etkinliğini artıran birçok unsur olduğunu düşünüyorum:

• Bazı komutların nasıl verildiğini veya bazı eylemlerin nasıl yapıldığını resimlerle gösterin (örneğin ekran görüntüleri).
• Bir şey yapma ihtiyacına ve bunu yapmanın yoluna odaklanın. Örneğin, bu işlemin ne kadar optimize edildiğiyle ilgili teknik açıklamalardan uzak durun.
• Modülleri tanımlayan bir akış şeması koyduktan sonra yazılım bölündü ve çok kullanışlı olmadığını söyledim.
• Sorun Giderme bölümünüzün yararlı olması için kullanıcının sahip olabileceği olası sorunları öngörmeye çalışın . Ayrıca, programınızı geliştirilmesine dahil olmayan kullanıcılarla, hatta diğer projelerde uyanan iş arkadaşlarınızla da test etmelisiniz.
• Sıkıcı açıklamalardan kaçının. Daha fazla bilgi ek ya da bunun gibi bir şeye eklenebilir.

Umarım bu sizin için yararlı olabilir.

Eğitim için kullanılacağından bahsettiniz.

Bir eğitim belgesine ziyade bir referans belge arıyorsanız, benim favori, site Mercurial üzerinde Joel Spolsky en öğretici olduğunu burada .

1. Basit, temiz sunum. Bakmak güzel.
2. Yetkili, ancak kişisel tonda. Harika bir üniversite dersindeymişsiniz gibi geliyor.
3. Basit resimler, bol miktarda gerçek ekran görüntüleri. Bunun neden işe yaradığını öğrenmek için Peçetenin Arkasını okuyun .

Eğer eğitim belgeniz Joel'in Mercurial öğreticisinin 1 / 2'si kadar güzel olsaydı, onu okurdum. Ancak, a) yazma tutkusu ve b) yukarıdaki 3 noktayı kopyalasanız bile, onu çıkarmak için inanılmaz bir bilgi derinliğine sahip birine ihtiyacınız vardır. Umarım çalışır.

Bu muhtemelen ihtiyaçlarınızı uygun olup olmadığını bilmiyorum, ama orada bir çevrimiçi dokümantasyon oluşturmayı kolaylaştıran akla gelen teknik sfenks için kullanılan sistemler var . Böyle bir şey ilgilendiğiniz şey için kullanılabilir mi?

Ben de sadece aynı şeyleri yapan ancak barındırılan bir çözüm olan ReadTheDocs ile karşılaştım .

Teknik İletişim Topluluğuna (STC) göz atın . Ödül kazananların birçoğu genellikle mevcut olan üretimi yazdı. Mevcut örnekleri de olabilir. Üye olmak, daha büyük bir bilgi kaynağına da erişim sağlayacaktır.