Documentation et formation des utilisateurs
Ce qu'on livre avec le logiciel pour qu'on sache s'en servir et le faire tourner : types de documentation, les quatre genres (tutoriel, guide pratique, référence, explication), notes de version et plan de formation.
- 23 cartes
- 3 thèmes
- Gratuit
Le programme, thème par thème
Le poids de chaque thème suit celui que lui donne l'examen.
- Notions
- Questions
- Ranger et relier
Quelques cartes du deck
Documentation utilisateur : de quoi s'agit-il ?
Voir la réponse
Ensemble des documents destinés à ceux qui se servent du logiciel pour accomplir leur travail, rédigés dans les mots de leur métier.
Elle explique quoi faire, pas comment c'est fait à l'intérieur : un utilisateur n'a pas à connaître l'architecture.
À qui s'adresse la documentation d'exploitation ?
- À ceux qui font tourner le logiciel en production
- Aux utilisateurs finaux qui saisissent les données
- Aux développeurs qui ajoutent des fonctions
- Aux clients qui décident de l'achat
Voir la réponse
À ceux qui font tourner le logiciel en production
Elle décrit démarrage, sauvegarde, surveillance et reprise après panne. Les développeurs lisent la documentation technique, les utilisateurs la documentation utilisateur.
Selon le cadre Diátaxis, les quatre genres de documentation sont le … (apprendre en faisant), le … (atteindre un but), la … (consulter des faits) et l'… (comprendre le pourquoi).
Voir la réponse
Selon le cadre Diátaxis, les quatre genres de documentation sont le tutoriel (apprendre en faisant), le guide pratique (atteindre un but), la référence (consulter des faits) et l'explication (comprendre le pourquoi).
Les mélanger dans une même page dessert le lecteur : celui qui apprend n'a pas besoin d'une liste d'options, celui qui consulte n'a pas besoin d'une histoire.
Documentation technique : de quoi s'agit-il ?
Voir la réponse
Documents destinés aux développeurs : architecture, conception, interfaces, choix et règles pour modifier le code.
Elle conditionne la maintenabilité : sans elle, chaque nouvel arrivant doit redécouvrir les choix en lisant tout le code.
Lequel de ces objectifs de formation est correctement formulé ?
- À l'issue de la séance, le stagiaire connaît le module de facturation
- À l'issue de la séance, le stagiaire saisit et envoie une facture sans aide
- À l'issue de la séance, le stagiaire a vu toute la démonstration
- À l'issue de la séance, le stagiaire comprend l'intérêt de la facturation
Voir la réponse
À l'issue de la séance, le stagiaire saisit et envoie une facture sans aide
Un objectif décrit ce que le stagiaire saura faire, de façon observable, ce qui permet de l'évaluer. « Connaître » et « comprendre » ne s'observent pas, et avoir vu une démonstration décrit une activité, pas un acquis.