Comprenez l’intérêt de ces manuels
Quand vous développez une application avec des fonctionnalités complexes, il est nécessaire de proposer des documents supports pour les futurs utilisateurs et développeurs qui en feront la maintenance.
C’est dans ce contexte que vous allez créer avec vos collègues un manuel d’utilisation et et un manuel de maintenance.
Le manuel d’utilisation a pour but d’expliquer aux futurs utilisateurs comment fonctionne l’application.
Par exemple, comment lancer le simulateur qui vérifie l’état de santé des fusées…Le manuel de maintenance, quant à lui, permet d’expliquer aux développeurs toutes les actions qu’ils devront faire pour assurer son bon fonctionnement sur le long terme.
Les librairies d’application à mettre à jour, comment gérer les sauvegardes ou les bugs…
Pour les raisons évoquées plus tôt, il faudra faire l’effort de créer un contenu clair et compréhensible pour les futurs destinataires de ces documents.
Assurez la clarté de vos manuels
Pour assurer la bonne compréhension de vos manuels, vous pouvez appliquer quelques principes.
Menez un workshop
Avec l’aide des développeurs et testeurs qui manipulent l’application en long et en large, nous organisons des ateliers afin de définir une structure compréhensible pour tous. Après le workshop, chaque personne aura la responsabilité de rédiger sa partie dans les délais fixés. Dans mon rôle de coordinateur, je vérifie la conformité des rédactions. Des tournures de phrases compréhensibles, des étapes bien décrites, etc.
Privilégiez un support en ligne
Pour gérer les évolutions futures, privilégiez un manuel consultable en ligne comme les wikis. Ce format est pratique pour faire des ajustements à n’importe quel moment si vous faites évoluer votre application.
Des outils comme GitBook, Confluence ou Read the Docs sont spécialement conçus pour faciliter la documentation de logiciels.
Vérifiez la complétude de vos manuels
Dans le contexte d'une application critique, vous ne pourrez pas laisser de place aux approximations dans votre documentation. Il vous faut réaliser des manuels de très bonne qualité. Vos utilisateurs auront de fortes attentes et voudront l'exploiter à son maximum. Malheureusement, on retrouve encore de nombreux cas de mauvaise rédaction qui impactent le travail de ces destinataires. Pour ces raisons, je vous suggère quelques règles d’or à appliquer afin de fournir une documentation correcte :
Ayez une structure simple.
Utilisez un langage simple.
Utilisez des visuels et captures d’écrans pertinents.
Fournissez des exemples concrets.
Ayez une mise en page aérée.
Choisissez une plateforme ergonomique et qualitative pour publier.
Décomposez vos instructions en étapes claires et numérotées.
Ayez des relecteurs exigeants qui vous guideront.
Relisez le manuel plusieurs fois pour corriger les fautes.
Vérifiez régulièrement que le manuel est à jour.
Demandez des feedbacks aux utilisateurs pour l’améliorer.
Garantissez la qualité de vos manuels
Afin d’apporter de la qualité dans vos manuels, mettez l’accent sur :
L’ergonomie et le design de présentation de votre contenu.
Cela peut vous paraître anecdotique mais lorsqu’un manuel est bien présenté avec de bonnes polices, hiérarchies d’informations et couleurs, vous permettez au lecteur de gagner en confort.
Il comprend mieux votre travail et passe davantage de temps à lire votre documentation pour maîtriser l’outil.
Sur certaines missions, il m’est déjà arrivé de m’arracher les cheveux en lisant une documentation tant c’était une torture. En tenant compte de cet aspect, votre travail sera grandement apprécié.
La qualité de l’indexation de vos données et du plan de navigation.
Le défi des utilisateurs de manuels est de trouver facilement l’information dont ils ont besoin. Je ne sais pas pour vous, mais quand je perds un temps fou à trouver une information simple sur un document qui est censé la contenir, je m’impatiente...
Avec le temps, l’attention des lecteurs diminue de plus en plus. Je vous conseille d’avoir un plan détaillé de navigation, qui sera visible en permanence, avec un bon moteur de recherche. Ainsi, vous rendrez l’expérience de recherche fluide pour les utilisateurs de vos manuels.
À vous de jouer
Contexte
La direction vous a confié la mission cruciale d'élaborer un manuel d'utilisation complet et structuré pour l'application de test de fusée, à réaliser sur la plateforme Notion.
Consignes
La réussite de ce manuel repose sur la précision et la clarté de son contenu. Voici les étapes clés à suivre pour mener à bien cette mission :
Assignation des rédacteurs : Sur la base des compétences et expertises de chaque membre de l'équipe, attribuez la rédaction de sections spécifiques à des profils appropriés. Par exemple, une personne experte en télémétrie sera idéale pour rédiger la section "Diagnostics et Télémétrie".
Structure du manuel : Créez le squelette du manuel d'utilisation sur Notion. Cela devra refléter les différentes fonctionnalités et sections du logiciel, telles que le système de lancement, les diagnostics, la simulation de vol, etc.
Intégration du contenu : Une fois que le squelette du manuel est en place et que les rédacteurs sont assignés, intégrez les éléments de texte fournis à la section appropriée. Assurez-vous que chaque fragment de texte est cohérent avec le sujet de la section.
En résumé
Pour des applications complexes, il est essentiel de fournir des manuels d'utilisation et de maintenance. Ces documents guident les utilisateurs dans le fonctionnement de l'application et aident les développeurs à assurer sa maintenance.
Pour une bonne compréhension des manuels, il est recommandé de s'appuyer sur les spécifications, d'organiser des ateliers avec les développeurs et testeurs, et d'envisager un support en ligne pour des mises à jour flexibles.
Une documentation de qualité nécessite une structure simple, un langage clair, des visuels pertinents, des exemples concrets et des relectures régulières pour s'assurer de sa pertinence et de son actualité.
L'ergonomie, le design, l'indexation des données et un plan de navigation efficace sont cruciaux pour rendre le manuel d'utilisation agréable à lire et facile à naviguer.
Après avoir approfondi la documentation et la création de manuels pertinents, passons à une étape clé en fin de projet : la conduite du post-mortem. Explorons ensemble comment en extraire les leçons importantes.
