Documentation de projets sur mesure : Quoi faire pour ne pas repartir à zéro à chaque fois
Si vous concevez des produits sur mesure pour vos clients, vous savez à quel point, même si chaque projet est unique, il est important de vous servir de votre expérience pour ne pas repartir à zéro à chaque fois.
Mais quand vous devez fournir de la documentation à vos clients, réussissez-vous aussi à faire en sorte qu’elle soit à la fois unique et adaptée à chaque projet, sans avoir à tout réinventer?
Pour réussir à produire efficacement de la documentation de qualité unique pour chacun de vos projets, vous devez bien vous préparer dès le départ. Ainsi, quand vous travaillez sur votre premier projet, gardez en tête qu’il y aura d’autres projets et que tous partageront certains contenus. Prenez aussi le temps de bien structurer votre projet et de mettre en place certains éléments de bases qui vous faciliteront la tâche lors de vos autres projets de documentation.
Un outil de gestion de contenu
Il y a probablement des parties de votre documentation qui s’appliquent à tous vos produits. Vos coordonnées, par exemple. Ou votre garantie. Ou encore certains conseils de sécurité ou explications quant à l’utilisation. Grâce aux outils de gestion de contenu, vous pouvez créer ce contenu commun et l’intégrer facilement à vos différents manuels et aides en ligne. De plus, certaines des fonctionnalités disponibles (variables, conditions, etc.) vous permettent de produire en un clin d’œil du contenu personnalisé à partir du contenu commun. Les outils comme MadCap Flare ou Adobe RoboHelp, par exemple, offrent aussi plusieurs options de formats. Vous pouvez donc, à partir d’une seule source, générer aussi bien un document Word ou PDF qu’une aide en ligne en HTML pour répondre à tous les besoins de vos clients.
Enfin, ces outils sont aussi précieux pour la gestion des traductions : quand le contenu est traduit pour un manuel, sa traduction est automatiquement récupérée pour être réutilisée dans les manuels suivants. Une bonne façon de gagner du temps et de réduire ses coûts de traduction.
Une liste de vérification
Si vos projets se ressemblent tous, votre documentation devrait toujours transmettre à peu près le même type d’information. La meilleure façon d’être certain d’avoir toute l’information dont vous aurez besoin pour la documentation au moment où vous serez prêt à la produire, c’est de dresser une liste de vérification des différents éléments requis. Cette liste varie évidemment d’une entreprise à l’autre, selon les projets et les produits, mais elle doit inclure précisément tout ce que vous devez fournir aux rédacteurs.
Une liste de vérification pourrait, par exemple, prendre la forme suivante :
- Description sommaire du projet et du client
- Contexte de l’installation
- Images du produit
- Liste des pièces
- Spécifications techniques
- Exigences quant à l’endroit où le produit sera installé
- Dessins liés à l’installation
- Etc.
Vous devriez créer cette liste lors de la production de la documentation de votre premier projet, en essayant de prévoir quels éléments seront essentiels dans tous les cas. Ensuite, à mesure que vous documentez des projets, assurez-vous de mettre régulièrement cette liste à jour. Votre liste deviendra ainsi, au fil du temps, de plus en plus précise et complète.
Une base terminologique
Que vous produisiez votre documentation à l’interne ou que vous fassiez affaire avec un sous-traitant, prenez le temps de définir les principaux termes liés à vos projets et produits. Pour ce faire, n’hésitez pas à demander la contribution de vos employés. C’est le meilleur moyen de faire en sorte qu’ils sont à l’aise avec les termes choisis et qu’ils les adoptent. N’oubliez pas qu’il faut continuellement mettre à jour cette base terminologique de façon à ce qu’elle reflète toujours la réalité de votre entreprise et de vos produits. Vous vous assurez ainsi que tout le monde parle le même langage, d’un projet à l’autre et d’un document à l’autre.
Prenez le temps de faire traduire votre base terminologique dans toutes les langues utilisées dans votre documentation. Cela facilitera grandement le travail de traduction et garantira que les termes utilisés seront toujours les mêmes, même si vous faites affaire avec différents traducteurs.
Un processus de travail
Vos projets sont probablement menés par différents chefs de projet, qui ne sont pas tous familiers avec la façon de collaborer avec les rédacteurs. Guidez-les en établissant un processus de travail qui comprend les grandes étapes à réaliser ainsi que les rôles de chacun à chacune de ces étapes. Le protocole devrait aussi établir quels intrants sont requis à quel moment. Dans ce processus de travail, vous pourriez établir clairement, par exemple, qui doit répondre aux questions des rédacteurs, qui doit effectuer les révisions et qui doit faire la validation finale. Si votre documentation prend la forme d’une aide en ligne, vous pourriez aussi définir à quel moment des tests d’expérience utilisateur devraient être menés, et par qui. Comme dans le cas de la liste de vérification, le processus de travail devrait être mis à jour et évoluer de manière à devenir le plus efficace possible.
Un responsable de la documentation pour tous les projets
Idéalement, une seule personne serait responsable, à l’interne, de la réalisation de la documentation et ce, même si vous faites affaire avec un sous-traitant. Le responsable de la documentation serait en quelque sorte la courroie de transmission entre les chefs de projet et le sous-traitant. Assurez-vous de choisir quelqu’un qui connaît bien les différentes équipes qui travaillent sur les projets, de façon à savoir qui peut fournir telle information manquante et qui est le mieux placé pour réviser ou approuver le contenu. Et faites en sorte qu’il ait du temps à consacrer à la gestion des projets.
En ayant quelqu’un qui supervise chacun des documents produits, vous vous assurez aussi de la cohérence de l’ensemble de votre documentation. Cela vous aidera à offrir à tous vos clients une expérience et une qualité égales.
Un outil de communication
Comme il y a souvent différents chefs de projet, c’est intéressant d’avoir un outil de communication qui permet de centraliser tous les échanges. C’est particulièrement utile quand de nombreux projets sont menés en même temps et que plusieurs chefs de projet ont besoin d’une même information. La réponse à une question pour un projet peut alors servir aussi aux autres projets. Les outils sont nombreux (Slack, Stride, Asana….). Il ne vous reste qu’à trouver celui qui correspond le mieux à vos besoins.
