Instructions de création d'aide-mémoire
Les aide-mémoire et les aide-mémoire composites permettent à un utilisateur d'atteindre un objectif en exécutant une suite d'étapes. Ces instructions expliquent comment utiliser les aide-mémoire et comment les rédiger dans les meilleures conditions.
A quel moment créer les aide-mémoire ?
Les aide-mémoire conviennent parfaitement aux tâches comportant des étapes à suivre qui mènent à un objectif défini, comme la construction d'une application simple. L'objectif doit être clairement établi pour que l'utilisateur puisse l'accomplir une fois toutes les étapes de l'aide-mémoire exécutées. Les tutoriels sont souvent de "bons candidats" pour les aide-mémoire, car l'objectif d'un tutoriel est d'apprendre à effectuer une tâche précise. Les aide-mémoire contiendront généralement 10 étapes et peuvent être accomplies en moins d'une demi heure.
Pour les tâches plus complexes, utilisez un aide-mémoire composite.
A quel moment créer des aide-mémoire composites ?
Les aide-mémoire composites servent à fournir un guide à travers une tâche qui est trop complexe à décrire dans un seul aide-mémoire ou qui comporte plusieurs objectifs. Un aide-mémoire composite peut être utilisé pour décrire une suite de tâches, dont chacune est bâtie sur une tâche précédente.
Dans quels cas ne faut-il pas utiliser les aide-mémoire ?
Les aide-mémoire sont les plus appropriés lorsqu'un problème peut être résolu par une suite d'étapes simples. Les aide-mémoire ne sont pas un substitut au système d'aide qui permet la création de pages HTML avec de riches graphiques et un accès sélectif aux informations à l'aide de recherches et d'hyperliens. Les aide-mémoire ne s'adressent pas aux tâches qui requièrent la saisie d'un nombre important de textes par l'utilisateur.
Instructions de création d'un aide-mémoire
- Choisissez un titre court et explicite.
- Utilisez des liens vers le système d'aide dans les tâches d'aide-mémoire chaque fois qu'il est possible de fournir un contexte ou des informations plus détaillées
- Pensez à convertir l'aide-mémoire en aide-mémoire composite s'il existe plus de 10 étapes.
- Utilisez des commandes chaque fois qu'il est possible d'effectuer des tâches plus complexes telles que : l'ouverture de perspectives, de ressources ou l'exécution d'assistants. Veillez également à indiquer une description de la manière d'obtenir le même résultat sans utiliser la commande.
- Assurez-vous que les commandes peuvent être ignorées si l'utilisateur décide de réaliser les étapes manuellement
- Indiquez dialog="true" pour les étapes relatives à l'ouverture des boîtes de dialogue. Cette opération entraîne l'ouverture de l'aide-mémoire dans une "zone de notification" située à droite de la plupart des boîtes de dialogue.
- Organisez les étapes de sorte que l'utilisateur puisse régulièrement voir des signes visibles de réussite. Un aide-mémoire qui apporte différentes modifications à un code source java puis lance une application doit être réécrit de manière à ce que l'application soit lancée après chaque modification de la source.
- Assurez-vous que l'utilisateur comprend l'objectif de chaque étape.
- Au lieu de décrire une étape de différentes manières, optez pour la manière la plus simple et qui requiert le moins de description possible.
- Utilisez des balises break (<br/>) pour améliorer la lisibilité.
- Vous pouvez utiliser des sous-éléments pour diviser les étapes en plus petites étapes.
- Les aide-mémoire ne requièrent pas toutes des sous-éléments.
- Commencez le texte du libellé du sous-élément par des mots d'action comme "Input", "Expand", "Select", etc
- Pour les libellés des sous-éléments, identifiez clairement le texte d'interface avec des guillemets afin de permettre aux utilisateurs de différencier le texte d'instruction du texte d'interface dont ils ont besoin pour les localiser et interagir avec eux.
- Chaque sous-élément doit correspondre à une tâche atomique, comme la saisie d'une valeur.
- Ajoutez toujours un élément <onCompletion> à la dernière étape d'un aide-mémoire.
- Vérifiez, en testant différentes tailles, que les aide-mémoire tiennent dans la vue.
- Testez les aide-mémoire en ayant la vue du journal des erreurs ouverte de manière à voir si des avertissements y sont consignés.
Instructions de création d'un aide-mémoire composite
- Un aide-mémoire composite doit contenir des tâches reliées par un thème commun.
- Chaque tâche dans un aide-mémoire composite doit avoir un objectif bien défini.
- Utilisez des éléments <onCompletion> pour indiquer une réussite.
- Les noms de tâche doivent être courts et concis.
- Les problèmes complexes peuvent être résolus en utilisant des tâches qui découlent de tâches précédentes.
- Utilisez skip="true" si une tâche est facultative.
- Pour des raisons de cohérence, assurez-vous que l'introduction et le nom d'un aide-mémoire simple correspondent à l'introduction et au nom de l'aide-mémoire composite.
- Pour les descriptions des tâches, mettez le texte d'interface en gras afin de l'identifier clairement.
- Des suites peuvent être utilisées, mais uniquement lorsqu'il est important d'appliquer un ordre de lancement des tâches.
Liens connexes
Utilisation des aide-mémoire
Utilisation des aide-mémoire composites
Aide-mémoire simples
Aide-mémoire composites