Est-ce que fournir des captures d'écran aide avec le manuel de documentation?
Je documente les rôles d'administrateur de site et de créateur de contenu pour mon application Web sur laquelle je travaille. Le manuel de documentation explique aux lecteurs comment ajouter, supprimer, mettre à jour des membres, des articles de presse et comment configurer le site avec différentes options.
J'ai demandé à l'un des développeurs de ajouter également des captures d'écran des pages sur la façon d'effectuer ces actions dans la documentation. Ce qui, je pense qu'il a raison, mais en même temps, je ne le fais pas.
Je sais que si l'utilisateur peut lire, alors il pourra suivre mes instructions dans ma liste commandée.
Exemple:
- Première étape, cliquez ici
- Deuxième étape, cliquez sur ceci
- Troisième étape, saisissez ceci
Dois-je ajouter des captures d'écran au manuel de documentation? Cela aiderait-il également la liste ordonnée d'instructions pour clarifier les choses pour les utilisateurs? Ou devrais-je rester avec ma méthode d'utilisation du texte uniquement?
Ces conclusions de Michael Hughes pourraient vous être utiles pour décider quand inclure une capture d'écran et quand ne pas:
Alors, où cela me laisse-t-il?
Je vais être plus ouvert à inclure des captures d'écran où ils font ce qui suit:
- Aider à rassurer l'utilisateur que l'endroit où ils se trouvent dans l'interface utilisateur est le bon endroit pour être
- Aide à attirer l'attention sur une zone spécifique d'une interface utilisateur complexe
- Prend en charge un exemple difficile à visualiser autrement, par exemple, la configuration d'une configuration de bureau
Donc, là où ils ajoutent de la valeur, je serai plus disposé à aborder les aspects qui rendent mon travail plus difficile (par exemple, la maintenance de la documentation). Mais comme je le ferais avec des mots, je vais supprimer l'évidence et tout ce qui n'ajoute pas de valeur.
Je préfère une approche additive (ne l'introduisez que lorsque les mots semblent inadéquats) à une approche soustractive (supprimez-la si cela semble superflu). En d'autres termes, je serai plus ouvert aux captures d'écran à l'avenir, mais ils doivent travailler eux-mêmes dans le document, pas seulement être leur droit jusqu'à leur expulsion.
Vous devez utiliser la capture d'écran dans le cas ci-dessous
Lorsque vous ne pouvez pas expliquer correctement l'écran avec des mots, c'est-à-dire s'il existe une option plus similaire à l'écran qui pourrait dérouter l'utilisateur.
Lorsque l'utilisateur pourra naviguer d'un écran à un autre écran qui ne sont pas cohérents, c'est-à-dire un changement majeur de l'interface utilisateur ou vous redirigez l'utilisateur vers une application différente.
En outre, vous pourriez penser que la capture d'écran de mise en place rendra la documentation volumineuse. Mais du point de vue de l'utilisateur, il est toujours bon d'inclure la capture d'écran, mais vous vous assurez d'inclure les détails requis uniquement dans la capture d'écran. Pas besoin d'inclure la partie de l'écran qui n'est pas requise à ce moment particulier. L'utilisation contextuelle de la capture d'écran est bonne tout en prenant soin du point mentionné ci-dessus.
P.S. L'objectif est de réduire la charge cognitive de l'esprit de l'utilisateur.
La meilleure chose à faire est de rendre l'application explicite, pour que les gens sachent quoi et où cliquer.
Et sur les écrans où cela ne fonctionne pas, vous pouvez inclure directement le manuel dans l'application, ajouter des conseils, des exemples d'images, des animations, tout ce qui est nécessaire pour comprendre la tâche.
Le fait d'avoir l'application et l'aide au même endroit vous aidera également à la mettre à jour chaque fois que vous modifiez l'application.
Personne ne lit plus vraiment les manuels et même s'ils le sont, vous aurez probablement manqué les points pertinents lors de leur rédaction. Facile à ajouter dans une application, difficile dans un manuel livré.
Si vous souhaitez minimiser le nombre de captures d'écran, vous pouvez toujours utiliser CSS pour afficher des zones sur les régions de la capture d'écran sur lesquelles vous souhaitez attirer l'attention de l'utilisateur, comme ici: http://www.bioinformatics.org/librarian/screenshots.php . Cela prendra du travail, mais l'affichage est magnifique et limite le bruit dans la documentation.
Si c'est comme une formation/"comment" le type de contenu que vous préparez des captures d'écran sera utile.
Si vous devez ajouter un membre, par exemple, vous pouvez écrire: "Sélectionnez la fonctionnalité> cliquez sur ajouter> entrez les détails> cliquez sur soumettre" et si vous fournissez un écran prenant en charge cette action en suivant ces instructions, il sera plus facile pour l'utilisateur de associez l'action à l'écran.
Maintenant, il peut y avoir une action simple comme la suppression d'un utilisateur/article et de son droit, moins susceptible d'être manqué. Dans ce cas, vous pouvez utiliser uniquement l'artefact visuel au lieu d'ajouter la totalité de l'écran: "Sélectionner une fonction> cliquer sur supprimer" et fournir uniquement l'artefact sur lequel l'utilisateur doit cliquer.
Si vous avez plusieurs actions qui utilisent le même écran comme ajouter/mettre à jour des détails utilisateur, vous pouvez fournir la capture d'écran tout en expliquant l'un des modules et l'utiliser comme référence dans l'autre. Cependant, cette approche est subjective de l'interface que vous fournissez pour l'utilisateur et du résultat net que les actions ont sur le système (pour le cas ci-dessus pour les actions, les informations utilisateur sont mises à jour)
Je pense que l'une des principales choses avec la conception de manuels d'utilisation est de connaître votre public. Si vous interagissez avec un public que vous pensez connaître le système, des instructions écrites sont acceptables. Cependant, si les utilisateurs sont nouveaux dans le système/l'interface utilisateur, les captures d'écran peuvent le rendre plus clair.
Certains utilisateurs apprennent de différentes manières. Certaines personnes réagissent mieux aux images visuelles qu'à une liste d'instructions et d'autres par des instructions verbales. En intégrant autant de styles d'apprentissage dans votre manuel, plus il est facile à comprendre pour l'utilisateur (bien que l'audio augmente parfois le temps, donc je l'éviterais personnellement)