Projets de documentation

Étude de cas · Documentation utilisateur

Documentation par tâches pour mobohubb

J’ai structuré et rédigé une documentation par tâches pour les quatre applications de mobohubb. Le portail sépare la configuration administrative des tâches de terrain et propose six parcours de prise en main à travers 86 guides.

Auteur
Christian Arango
Rôle
Rédacteur technique et ingénieur documentaire
Site en ligne
mobohubb.readme.io
Capture
Site public, 13 octobre 2026
Le lecteur commence par choisir l’application qu’il utilise.Voir la page source

Le problème

Quatre applications, plusieurs tâches de lecture

mobohubb aide les équipes mobiles à gérer les plannings, le pointage, les tâches, les formulaires et les points de contrôle QR/NFC. Ses lecteurs vont des administrateurs dans un portail web aux équipes de terrain sur un téléphone ou un kiosque partagé.

  • 86 guides par tâches répartis entre quatre applications

  • 941 captures placées étape par étape sur 83 pages sur 86

  • 74 guides rédigés sous forme de procédures numérotées

  • ~40k mots d’explications publiées

Architecture de l’information

Organiser l’aide par application, puis par tâche

Les lecteurs arrivent en sachant quelle application ils utilisent, pas quelle fonctionnalité il leur faut. Chaque application a donc sa propre barre latérale, calquée sur ses menus.

  • Les versions ReadMe comme sélecteur d’applications

    Chaque application vit dans sa propre version ReadMe, si bien que l’en-tête remplace toute la barre latérale sans maintenir quatre projets.

  • Séparer l’administration du travail de terrain

    La configuration reste dans Portal, si bien que les équipes de terrain ne parcourent jamais de réglages inutiles.

  • Produit bilingue, documentation en anglais

    Le portail fonctionne en espagnol ou en anglais ; les guides traitent le changement de langue comme une tâche à part entière.

Rédaction

Garder les instructions au plus près de la tâche

Les équipes de terrain lisent sur leur téléphone, pendant leur service, souvent pour une seule tâche. Chaque guide les aide à trouver leur étape et à la comparer à l’écran.

  • 63 sur 86

    Le résultat d’abord

    Les guides commencent par « In this guide you’ll learn » : le lecteur sait en quelques secondes qu’il est sur la bonne page.

  • 941 captures

    Un écran pour chaque étape

    Les captures de téléphone restent étroites, comme l’appareil ; celles de Portal sont larges.

  • Style

    Mettre en évidence l’élément à toucher

    Des étapes à l’impératif, avec le libellé exact de l’interface en gras : touchez Take a break.

  • 42 guides

    Des notes là où surviennent les erreurs

    Un callout à l’étape exacte où le lecteur peut se tromper, par exemple sur les informations de connexion à utiliser.

Prise en main

Un point de départ pertinent pour chaque public

Au lieu d’une seule page de démarrage, le portail propose six parcours rapides, chacun rédigé pour un public et une tâche.

  • Des liens croisés plutôt que des répétitions

    Les parcours rapides renvoient aux guides complets au lieu de les répéter.

  • Des onglets pour les visites d’interface denses

    Les écrans chargés se visitent une zone à la fois, avec les onglets ReadMe.

  • Un contenu tenu à jour

    La plupart des guides ont été mis à jour entre mars et juin 2025, avec des modifications jusqu’en mai 2026 au fil des changements d’interface.

Le résultat

Ce que démontre le portail publié

  • Analyse des publics

    Des parcours séparés pour les administrateurs, le personnel de bureau, les équipes de terrain et les utilisateurs du kiosque.

  • Rédaction procédurale et visuelle

    74 guides pas à pas avec résumé du résultat, libellés exacts de l’interface et 941 captures dimensionnées selon l’appareil représenté.

  • Front end sur une plateforme hébergée

    Une page d’accueil HTML/CSS personnalisée dans ReadMe, avec les versions réutilisées comme sélecteur d’applications.

  • Maintenance

    Des guides alignés sur une refonte du produit plus d’un an après le lancement.