|
Nous avons demandé aux auteurs techniques à Cherryleaf pour obtenir des conseils sur l'écriture de fichiers d'aide. Ce sont leurs 15 premiers conseils. 1. Pensez à ce que votre auditoire besoins ou désirs. Parlez-en à vos utilisateurs. Découvrez ce que votre lutte avec les utilisateurs, ce qu'ils savent déjà, quels types de renseignements dont ils ont envie, ce que les tâches qu'ils accomplissent le plus souvent, ce que le vocabulaire qu'ils utilisent, ce qu'ils font avant, pendant et après l'utilisation du système. 2. Si vous ne pouvez pas parler à vos utilisateurs, parlez à votre Help Desk et de services de formation. 3. Planifiez votre table des matières avant de commencer à écrire. 4. Structure de la table des matières, afin que vous les utilisateurs trouveront qu'il est facile d'y naviguer. Ne pas enterrer trop de sujets profonds - l'utilisateur ne pourra jamais les trouver. 5. Ecrire à un niveau de détail qui est appropriée pour votre auditoire. Si possible, gardez-vous des sujets à court et à un point 6. Thèmes Nommez votre bon sens, de sorte qu'un utilisateur peut les regarder et de savoir quelles informations ils trouveront au sein d'un sujet particulier. "Informations générales" ou "divers" sont d'aucune utilité à personne. 7. Viens une seule intervention par sujet. 8. Adresse vos instructions directement à l'utilisateur - d'éviter la voix passive. 9. Ne mélangez pas des informations conceptuelles avec des informations pédagogiques. 10. Utiliser une feuille de style pour la cohérence. Vous pouvez souvent l'utiliser à nouveau comme une base pour d'autres projets, économisant ainsi du temps. 11. Popups utilisation / l'expansion text / déroulant texte de dissimuler des informations qui seront facultatives pour l'utilisateur. 12. Évitez d'utiliser l'indentation pour indiquer les sous-sections. Utiliser l'espace blanc vertical à la place. 13. Passez du temps sur l'indice, car de nombreux utilisateurs se penchera sur des sujets ici. 14. Inclure des synonymes dans votre index. 15. Évitez d'utiliser du grand écran capture. Au lieu de cela, un clip de l'image pour montrer que la partie qui est décrite. (c) Cherryleaf techniques auteurs et spécialistes de la documentation 2006. |