Rédaction de manuel utilisateur et d’aide en ligne
Pourquoi externaliser la rédaction des manuels utilisateur et des aides en ligne ?
En quoi cela consiste-t-il ? La conception d'une telle documentation consiste à analyser
le produit à documenter, ainsi que les besoins et les attentes des lecteurs de cette
documentation, puis à proposer un plan et une présentation adaptés aux utilisateurs.
La rédaction de cette documentation intervient après sa conception : elle consiste
à formuler, dans le cadre du plan et de la présentation ainsi définis, les différents
éléments d'informations destinés aux utilisateurs du produit. Cette prestation peut
être effectuée selon tout ou partie de la norme ISO/IEC 26 514.
- Expliquez bien le logiciel à la personne chargée de concevoir et de rédiger sa documentation
- Instaurez un dialogue permanent
- Investissez du temps pour lire et corriger en particulier les premières versions
des documentations
- Si vous envisagez de rédiger vous-même, vous pouvez appliquer tout ou partie de nos
conseils pour la rédaction.
Les raisons de sous-traiter la conception et la rédaction d'une documentation sont
nombreuses :
- Les techniciens à l'origine du produit peuvent ne pas avoir de temps à consacrer
à la documentation.
- Les techniciens n'ont pas nécessairement le goût de l'écriture ou une pratique suffisante
en la matière.
- Les concepteurs d'un produit ne disposent parfois pas du recul nécessaire pour se
mettre à la place de l'utilisateur qui découvre ou qui doit réellement utiliser ce
produit.
- Les documentations de produits complexes demandent une conception plus sophistiquée
de la présentation des informations : introductions, rappels, encadrés récapitulatifs,
schémas, exemples, charte graphique, glossaire, etc. Il est donc nécessaire de faire
appel à un professionnel qui a déjà expérimenté et résolu les problèmes posés par
cette complexité.
- La rédaction d’un manuel utilisateur par une personne externe à l’équipe des développeurs
permet parfois d’affiner ou d’améliorer l’interface ou certains concepts présents
dans le logiciel. En effet, pour décrire au mieux le fonctionnement du logiciel,
le rédacteur va l’utiliser avec le point de vue de l’utilisateur final, ce qui peut
l’amener à faire des suggestions d’amélioration.
Nouveau : les formats d’aide en ligne disponibles sont HTML Help, WebHelp, Windows
Exe et ePub eBooks, Adobe PDF, RTF et WinHelp. De plus, il est possible de générer
à la fois l’aide en ligne et le manuel utilisateur depuis une même source XML.