Bonnes références pour des exemples de documentation pour les utilisateurs finaux et des conseils [fermé]

10

Notre logiciel interne a été utilisé pour de nombreux utilisateurs et le service de formation nous a demandé des conseils sur le format de documentation de l'utilisateur final.

Est-ce que quelqu'un sait où puis-je trouver de bons exemples de documentation utilisateur final de logiciel qu'un département de formation peut utiliser pour l'inspiration ou des sites avec de bons conseils?

Ceci est similaire à cette question, mais je recherche une documentation destinée aux utilisateurs finaux à l'usage des utilisateurs non techniques.

design documentation users

— John
source

1

"Où puis-je trouver de bons exemples de documentation pour les utilisateurs finaux de logiciels" Étape 1. Achetez des logiciels. Étape 2. Lisez la documentation. Qu'est-ce qui vous empêche de récupérer la documentation d'un logiciel existant que vous utilisez déjà? Je crois que la plupart des packages pour utilisateurs finaux ont la documentation complète en ligne. Qu'est-ce qui vous empêche de lire la documentation de Microsoft pour leur suite Office?

— S.Lott

Je crois que la plupart de la documentation que j'ai lue est écrite d'une manière qui n'est pas attrayante à lire, et la plupart des livres que j'ai sont généralement liés à la programmation destinés au public technique. Vous voyez juste quand quelqu'un a lu le manuel Microsoft pour la dernière fois? Par conséquent, je cherchais des exemples inspirants.

— John

Hmm, intéressant q.

— Rook

@John: "la plupart de la documentation". D'accord. Donc, après avoir jeté "la plupart", que reste-t-il? Nous ne savons pas pourquoi vous rejetez une partie de la documentation la plus utilisée sur la planète comme "peu attrayante à lire". Vous pouvez étoffer votre liste de réclamations et ajouter votre courte liste personnelle d'exemples de documentation logicielle qui n'est pas exclue par votre test "pas attrayant pour lire". Nous ne vous connaissons pas très bien, nous ne pouvons donc pas deviner pourquoi vous entendez par «ne pas faire appel à la lecture».

— S.Lott

2

Faisons attention à ce que nous n'ayons pas besoin de questions avec des critères si spécifiques de ce qui est "bon" que cela devienne localisé et non applicable à la plupart des gens. Je ne suis pas intéressé par les jeux de couleurs.

— JeffO

1

Vous voudrez peut-être commencer par interroger vos utilisateurs internes sur le logiciel et découvrir le type d'informations qu'ils souhaitent connaître.

Une grande partie de la documentation que j'ai écrite sur les logiciels a eu un ou plusieurs publics à l'esprit. Votre service de formation bénéficierait probablement d'un squelette de sujets (comme une table des matières). Vous pourrez alors discuter des sujets pertinents et de ceux qui ne sont pas pertinents pour leurs objectifs de formation.

Certains des sujets pourraient couvrir:

Public (s) cible (s)
Les pré-requis techniques
Comment installer (le cas échéant)
Processus (c.-à-d. Quelle fonction commerciale le logiciel remplit-il?)
Ensemble de fonctionnalités (quelles sont les fonctionnalités du logiciel?)
- Vous pouvez avoir une approche basée sur les tâches pour cela, par exemple Ajouter un utilisateur ou Ajouter un document
- Vous pouvez avoir une approche basée sur les objets, par exemple les utilisateurs, les rôles
- Vous pouvez avoir une approche basée sur le menu, par exemple le menu Fichier, le menu Affichage
Enfin, une section sur les fonctionnalités à venir et la FAQ pourrait éventuellement servir de référentiel de connaissances croissant pour votre produit.

Essayez d'anticiper la façon dont vos utilisateurs finaux utilisent votre logiciel, en fonction de votre connaissance de son développement, de votre connaissance de ce qu'il fait et également en fonction (espérons-le) de vos entretiens avec les utilisateurs finaux.

Plus important encore, essayez de créer une documentation que vous souhaitez lire, utilisez des exemples de noms amusants pour illustrer et utilisez de nombreuses captures d'écran annotées.

J'espère que cela t'aides

— funkymushroom
source

2

J'ai lu plusieurs "guides de l'utilisateur final" et j'en ai rédigé un, et je pense qu'il existe de nombreux éléments qui améliorent leur efficacité:

Montrez avec des images comment est émise une commande, ou faites une action (captures d'écran par exemple).
Concentrez-vous sur la nécessité de faire quelque chose et sur la façon de le faire. Éloignez-vous des descriptions techniques sur l'optimisation de cette action par exemple.
Une fois que j'ai mis un organigramme décrivant les modules, le logiciel a été divisé et j'ai reçu des commentaires selon lesquels ce n'était pas très utile.
Essayez de prévoir les éventuels problèmes qu'un utilisateur peut rencontrer afin que votre section Dépannage devienne utile. Vous devez également tester votre programme avec des utilisateurs qui n'ont pas été impliqués dans son développement, même vos collègues qui se sont réveillés sur d'autres projets.
Évitez les descriptions ennuyeuses. Toute autre information peut être mise en annexe ou quelque chose comme ça.

J'espère que cela peut vous être utile.

— Nicolás
source

1

Vous mentionnez qu'il sera utilisé pour la formation.

Si vous recherchez un document de formation plutôt qu'un document de référence, mon site préféré est le tutoriel de Joel Spolsky sur Mercurial ici .

Présentation simple et nette. C'est agréable à regarder.
Autoritaire, mais de ton personnel. C'est comme si vous étiez dans une grande conférence universitaire.
Des images simples, pas beaucoup de captures d'écran réelles. Lisez le verso de la serviette pour savoir pourquoi cela fonctionne.

Si votre document de formation était 1/2 aussi cool que le tutoriel Mercurial de Joel, je le lirais. Mais vous avez besoin de quelqu'un avec a) une passion pour l'écriture et b) une profondeur incroyable de connaissances pour réussir, même si vous pouvez copier les 3 points ci-dessus. Esperons que ça marche.

— MikeRand
source

0

Je ne sais pas si cela correspond à vos besoins, mais il existe des systèmes utilisés pour la documentation technique sphinx qui me vient à l'esprit et qui facilitent la création d'une documentation en ligne. Est-ce que quelque chose comme ça pourrait être utilisé pour ce qui vous intéresse?

Je viens également de parcourir ReadTheDocs qui fait à peu près la même chose mais qui est une solution hébergée.

— Piper Merriam
source

0

Découvrez la Société pour la communication technique (STC) . Beaucoup de leurs lauréats ont écrit une production qui est généralement disponible. Ils peuvent également avoir des échantillons disponibles. Devenir membre donnera également accès à un plus grand nombre d'informations.

— Jim Rush
source