Écrivant l'aide utile - une liste de contrôle de minimalisme

La documentation d'utilisateur est toute trop souvent écrite par des programmeurs pour des programmeurs. Elle tend à se concentrer sur les caractéristiques du produit, plutôt que l'utilisateur charge. Généralement, les programmeurs ne sont pas en position idéale à être documentation d'utilisateur d'écriture. Ils sont trop près du peu et des bytes, et ils sont trop loin de l'utilisateur. À eux, ce que le produit peut faire tend à être plus important bien que ce que l'utilisateur peut faire avec le produit.

C'est - mais essentiel - une distinction subtile. La recherche prouve que la clef à la documentation d'utilisateur efficace écrit l'aide adaptée à la tâche. Même améliorer, écrire votre aide selon la théorie de minimaliste. Dans le monde de documentation, le « minimalisme » est un mot de fantaisie pour une pratique en matière de bon sens. En termes de base, il signifie écrivent à votre lecteur et le maintiennent simple.

La théorie elle-même a beaucoup de torsions et de tours. Si vous voulez lire un grand - mais légèrement diffus - réserver sur le sujet, contrôle dehors le livre « minimalisme au delà de l'entonnoir de Nurnberg », 1998, édité par John Carroll.

En attendant, si vous pouvez faire tic tac chaque article dans la liste de contrôle suivante, vous irez bien sur votre chemin à l'aide en ligne utilisable pour laquelle vos lecteurs et vos directeurs vous remercieront.

Liste de contrôle utile d'aide

1. Baser l'aide sur vrai charge (ou les exemples réalistes)

2. Structure l'aide basée dessus charge l'ordre - les titres de chapitre devraient être des buts et les matières devraient être charge

3. Respecter l'activité du lecteur - c'est généralement plus au sujet de ce que vous ne faites pas que ce que vous. Ne pas perdre le temps du lecteur par la plongée au loin dans des tangentes

4. Exploiter la connaissance et une expérience antérieures - appeler l'attention du lecteur sur précédent charge, des expériences, des succès, et des échecs

5. Empêcher les erreurs - « vous assurer fait x avant de faire y »

6. Détecter et identifier les erreurs - « si ceci échoue, vous avez pu être entrés dans le chemin inexactement »

7. Erreurs de difficulté - « resaisir le chemin »

8. Fournit l'information d'erreur à la fin de charge en cas de besoin (le principe de base, une note d'information d'erreur par trois charge est une bonne moyenne)

9. Ne pas casser vers le haut les instructions avec des notes, des attentions, des avertissements, et des cas exceptionnels - mettre ces choses à la fin de l'instruction, dans la mesure du possible

10. Être dossier, ne pas orthographier tout dehors, particulièrement les choses qui peuvent être prises pour accordé

11. Omettre conceptuel et noter l'information dans la mesure du possible, ou le lien à lui. Peut-être fournir les informations d'expansion à la fin de la matière, plus peut-être une note qu'il y a d'autres manières d'exécuter le charger/but, mais c'est le plus facile

12. Les sections devraient regarder le short et lire sous peu

13. Fournir la fermeture pour des sections (par exemple, de nouveau à l'écran original/au but)

14. Fournir une occasion immédiate d'agir et d'encourager l'exploration et l'innovation (les invitations actives d'utilisation d'agir, comme, « voient pour vous-même… » ou « essayer ceci… » plutôt que les invitations passives comme, « toi pouvez… »)

15. Mettre les utilisateurs en route rapidement

16. Tenir compte de la lecture dans n'importe quel ordre - rendre chaque section modulaire, particulièrement buts, mais peut-être la charge (certainement s'ils peuvent être exécutés dans l'ordre différent)

17. Choses de point culminant qui ne sont pas typiques

18. Employer la voix active plutôt que la voix passive

19. Essayer d'expliquer l'environnement d'utilisateur dans votre écriture

20. Avant l'écriture quelque chose, se demander que « cette aide mon lecteur ? »

En établissant ces pratiques dans votre processus de documentation, vous constaterez qu'il devient plus facile écrire votre aide en ligne, abréviation, et bien plus utilisable votre lecteur. Ce qui est plus, votre patron vous aimera !