Documentation technique: Manuel imprimé pour Petitpierre SA
Dans le cadre de la réalisation complète de la documentation du Lumen, un appareil de mesure optique de la société Petitpierre SA, le manuel utilisateur est une pièce des plus importante qui doit refléter l’excellence du produit.
Contraintes
- Le manuel doit être directement abordable – l’utilisateur ne doit pas être obligé de le parcourir entièrement pour installer l’appareil et le mettre en fonction.
- Il est publié en tant que manuel en ligne (recherchable, format site web), en tant que PDF « A4 » et en tant que manuel imprimé A5.
- Il doit être facilement mis à jour, suivi et ses modifications identifiables.
- Il doit respecter les normes permettant de protéger utilisateur et constructeur.
Rédaction et illustration
Naturellement, le manuel a été rédigé en respectant la norme 16007. Une structure standard permettant de n’omettre aucun « chapitre », de l’installation au recyclage de l’appareil.
Nous optons pour un format ouvert (voir lien propriétaire – open source), du XHTML, soit un langage facile à éditer, à modifier, très compréhensible et utilisable avec de très nombreux éditeurs.
Il est modulaire. Les grandes structures que sont les chapitres sont séparées, mais également les « articles ». Ainsi, il est possible de consulter des portions de manuel en tant que pages web.
Enfin, nous avons opté pour un rendu photo réaliste des illustrations. Bien que l’appareil n’existait pas encore lors de la réalisation du manuel, cette tâche n’a pas été compliquée compte tenu des outils actuels.
Par contre, l’utilisateur peut plus rapidement identifier les composants de l’appareil que sur des rendus dits « filaires » ou des photographies détourées.
Les rendus photos réalistes permettent de mettre en exergue les éléments importants, et sont ici issus d’une animation complète destinée à la prise en main de l’appareil (voir lien).
Publication et impression
Aussi simple que cela puisse paraître, publier un manuel dans ses différents formats tout en s’assurant qu’il soit toujours lisible, compréhensible et accessible n’est pas toujours chose évidente.
Tout d’abord, lorsque l’on change de format, on souhaite conserver une mise en page flatteuse. Après tout, un manuel reflète la qualité du produit, c’est important.
Ensuite, selon le nombre de pages, ce type de document une fois imprimé prend… de l’espace !
Il doit s’insérer dans le packaging prévu à cet effet, ne pas dépasser une certaine hauteur, se maintenir dans le temps.
Ce pour quoi un « dos carré collé » a été choisi pour son impression. L’épaisseur est tributaire du grammage du papier, de la couverture, mais aucune reliure (spirales, agrafes) n’est nécessaire et l’aspect final est celui d’un album photo de qualité ou d’un livre de poche.
Une impression couleur pour tout le manuel ainsi qu’un papier de qualité pour la couverture comme pour son contenu donnent un aspect relativement luxueux à l’ensemble. Ceci grâce à la sélection de prestataires de qualité avec qui nous avons l’habitude de collaborer.
Du HTML pour une impression ?
Oui, le HTML ou XHTML tout comme d’autres formats (XML, etc.) sont parfaitement adaptés. Nous avons pour habitude de travailler avec MadCap flare. Il remplace souvent avantageusement Frame Maker (Adobe) et sa stabilité est sans commune mesure avec les outils Office.
Remanier la mise en forme générale d’un document rédigé dans ce format se fait au moyen de feuilles de style de troisièmes générations (CSS3) qui intègrent quantité d’aspects typographiques et de mise en page.
Cependant, bien que nous appréciions l’outil Flare (voir vidéo), lorsqu’il est question de générer un document lourd (par ses illustrations ou son nombre de pages), la vitesse n’est pas au rendez-vous. Or il faut effectuer nombre de publications pour relecture. Générer un document peut prendre parfois plusieurs minutes (les habitués de Frame Maker le savent également).
Autre « petit » écueil, les césures. Le français ne se découpe pas comme l’anglais et nécessite naturellement un dictionnaire adapté pour que bon-jour ne se transforme pas en bonj-our lors du changement de mise en forme.
Nous travaillons donc avec notre propre générateur de PDF (ci-contre) couplé à un dictionnaire par langue.
Trio gagnant
Les vainqueurs sont donc Flare, notre générateur « in-house » et Prince XML .
Au moyen de ces trois outils, il est possible de générer un manuel en quelques secondes avec une grande précision.
Naturellement, le suivi des modifications et les traductions ne sont pas abordés dans ce cas de figure. Cependant, l’ensemble est versionné, et une structure stricte est respectée pour chaque langue.
Ainsi, dans ce cas comme pour d’autres clients à qui nous avons confiés nous outils de génération, les modifications mineures sont réalisées in-house et nous nous chargeons des rendus et modifications majeures.
