03 - Guide d'utilisation
Préparer un guide d'utilisation à l'intention de votre client.
Détails de la tâche
Valant pour 10% de la note finale, vous devez produire pour votre client un guide d'utilisation de type guide de démarrage pour l'application.
Le guide d’utilisation, de type Guide de démarrage (Getting started), doit couvrir les sujets suivants:
- Structure de l'application et sections/fonctionnalités principales
- Configurations utilisateur et personnalisation de l'application (si applicable)
- Comment utiliser les principales fonctionnalités
- Particularités, limites, contraintes et problèmes connues
De plus, il est important de respecter les bonnes pratiques en matière de création de documentation utilisateur:
- Séparation en sections logiques (thèmes, catégories de fonction, selon le type d'utilisateur, etc.)
- Utilisation de titres et segmentation de l'information dans les pages
- Raccourcis et liens vers d'autres sections d'intérêt ou articles au besoin
- Gradation du niveau de détail: commencer de simple à plus complexe.
- Présence d'images pour venir appuyer le texte avec emphase sur certains éléments si pertinents (flèches, surbrillance, etc.)
- Présence d'exemples
- Séparation en étapes (1, 2, 3, ...)
- Être clair et concis (petits paragraphes, phrases courtes, etc.)
- Utilisation de points de forme et de listes pour structurer l'information, varier la présentation de l'information et donner une forme de rythme à la page
- Adapté au type d'utilisateur et comprendre son contexte (technique vs non technique)
- Utilisation de tableaux récapitulatifs ou récapitulatifs général lorsque pertinent
- Présence d'aide secondaire via blocs astuces, info, etc.
- Recherche (lorsque via un site web)
Voici un exemple d'un article de documentation utilisateur présentant la majeure partie des éléments attendus pour décrire une fonctionnalité (ex.: gestion de boards dans Miro):
Vous pouvez utiliser comme base la théorie vue dans votre cours de soutien technique reliée à la création d'une bonne documentation utilisateur. Vous pourrez utiliser les notions apprises pour vous aider dans la rédaction du guide.
De plus, vous apprendrez à utiliser l'outil Docusaurus permettant de mettre en ligne un site de documentation (le site sur lequel vous êtes en ce moment est fait avec Docusaurus!).
Vous pouvez utiliser cet outil pour créer votre documentation. Cependant, soyez conscient que par défaut, un site publié est public. Si votre documentation contient de l'information sensible ou privée, cela n'est possiblement pas le meilleur choix.
Vous pouvez publier votre projet sur GitLab et mettre le site privé. Cependant, vous devrez demander à votre client de se créer un compte Gitlab pour accéder à la documentation.
Vous pouvez aussi créer la documentation dans l'outil de votre choix: Confluence, Google Docs, Word, etc.
Au final, il est de votre responsabilité de choisir le bon outil en fonction de votre client et du contexte.
Modalités de remise
- Remis via Gitlab et/ou Confluence
- Selon le format du guide
- Word ou autre: fichier placé dans une section
Remise Finalede votre Confluence. - Docusaurus: me donner accès à votre repo contenant le docusaurus (@bentremblay.cd) et mentionnez l'URL dans une section
Remise Finalede votre Confluence.
- Word ou autre: fichier placé dans une section
- À remettre avant le 9 mars 2025 23:59
Grille d'évaluation
| Critère | Points |
|---|---|
| Identification des procédures et éléments importants à couvrir | 25% |
| Particularités, limites, problèmes possibles et solutions | 25% |
| Qualité, détails et clarté des éléments couverts | 50% |