248.821.8832

julie@juliemcdonough.com
jmcdonoughblog.wordpress.com

Exemple de guide d`utilisation

Il n`existe aucune combinaison ou séquence standard de ces éléments; chaque entreprise le fait différemment. Vous devez également éviter de longues phrases Wordy et nous vous recommandons de décomposer les tâches en deux ou plusieurs sous-tâches lorsque l`utilisateur doit effectuer plusieurs actions. Lorsque cela se produit, certains éléments du Guide de l`utilisateur sont divisés en leurs propres volumes distincts, en particulier les procédures d`installation, les procédures de dépannage et les commandes. La vidéo agit comme un enseignant pour expliquer un processus global et de fournir une formation initiale. Vous pouvez également tirer parti des sous-étapes pour rendre votre documentation plus facile à suivre. Sinon, les utilisateurs finaux gaspillent du temps à chercher ce que vous venez de référencer. Lorsque vous référencez une autre action, un produit, un flux de travail ou un terme, il est toujours utile d`inclure un lien vers l`article connexe. L`ajout d`une flèche, d`un cercle ou de séquences de numéros peut rendre la documentation de l`utilisateur final complètement factice, et sauver les utilisateurs finaux d`avoir à comprendre ce qu`il faut faire. Voici un exemple de l`intégration de ScreenSteps avec Salesforce. Il s`agit de la documentation logicielle pertinente pour diverses versions entre 2008 et 2013. Les manuels d`utilisation et les guides de l`utilisateur pour la plupart des applications logicielles non triviales sont des documents de type livre avec des contenus similaires à la liste ci-dessus. Remarque: tous les styles et formats suivants ne sont pas nécessairement recommandés.

Bien que cette définition suppose des ordinateurs, un guide de l`utilisateur peut fournir des instructions d`utilisation sur pratiquement n`importe quoi: tondeuses à gazon, fours à micro-ondes, lave-vaisselle, et ainsi de suite. L`utilisateur suit ces étapes en glissant les instructions sur un appareil mobile ou sur un ordinateur de bureau. Comme vous pouvez le voir, un guide de l`utilisateur rassemble un grand nombre des sujets abordés dans ce manuel en ligne. Vous trouverez des détails sur le contenu, le format et la conception de ces éléments dans le chapitre du livre-Design. Ci-dessous il y a aussi des guides individuels pour l`installation, le module de précipitation (TC-PRISMA) et chacun des kits de développement logiciel (SDK). Un exemple est le Guide de démarrage de Picasa. Il contient chaque sujet, instruction, et étape de la façon d`utiliser un produit spécifique. Dans le cas des applications informatiques, il est habituel d`inclure des captures d`écran de l`interface homme-machine (s), et les manuels de matériel comprennent souvent des diagrammes clairs et simplifiés.

Certains documents ont une structure plus fluide avec de nombreux liens internes. Tous les problèmes sont basés sur un manuel de Mats Hillert. Par exemple, en fonction du logiciel, les ensembles comprennent les guides de l`utilisateur du module thermo-Calc et/ou de diffusion, les références de commande, les guides d`exemple, les guides d`utilisation de l`optimisation des données et du gestionnaire de bases de données. Au lieu d`aller droit à l`information dont ils ont besoin, les utilisateurs finaux devront passer au crible toutes les autres choses pour trouver une réponse. Par exemple, pensez à combien de temps il faudrait pour écrire un article intitulé “contacts”-vous ne savez pas par où commencer. Il y a un objectif clair dans chaque instruction, et la description de l`objectif doit donc toujours être orientée vers les tâches et au point. Équilibre de phase, diagrammes de phase et transformations de phase 2e édition, Cambridge University Press, 2007 ISBN-13:9780521853514. Il s`agit d`un thème dans un manuel d`instructions. Dans certaines applications logicielles d`entreprise, où les groupes d`utilisateurs n`ont accès qu`à un sous-ensemble de la fonctionnalité complète de l`application, un guide de l`utilisateur peut être préparé pour chaque groupe.