Conseils d'experts pour une documentation technique de qualité

Bonnes pratiques

Technical-documentation-header-image

En quoi la documentation technique est importante ? Comment bénéficier d'une documentation technique de haute qualité ? Quels sont les défis de la documentation technique et son avenir ? Pour répondre à ces questions, nous avons interrogé 2 professionnels expérimentés de la documentation technique :

  • Karl Bjelkesjö, Technical Communications & Business System Tools chez Xylem,
  • Mats Hermansson, Technical Information Strategy Manager chez SAAB.

Découvrez leurs points de vue sur la documentation technique et leur ambition de réinventer cette industrie par l'intermédiaire de la BOTI (l'organisation industrielle suédoise pour l'information technique). 

 

Pourquoi la qualité d'une documentation technique est-elle importante ?
Qu'est-ce qu'une bonne documentation technique ?
Dans quels secteurs la documentation technique nécessite-t-elle une attention particulière ?
Comment les autres services de l'entreprise peuvent-ils aider à la production de cette documentation ?
Quel est le plus grand défi du secteur de la documentation technique ? 
Qu'est-ce que la BOTI ? 

 

Pourquoi la qualité d'une documentation technique est-elle importante ? 

L'information technique permet d'accroître la satisfaction du client et d'optimiser l'utilisation du produit. Elle est la raison même pour laquelle on cherche à obtenir une documentation technique de haute qualité. Dans certains secteurs, la documentation technique est même une obligation en raison de la responsabilité des fabricants. 

 

En quoi la qualité de production d'une documentation technique bénéficie-t-elle aux entreprises ? 

Karl : La documentation technique confère aux entreprises un avantage concurrentiel, car elle améliore l'expérience de l'utilisateur et booste les ventes. L'information technique doit être facilement accessible tout au long du parcours client. En résumé, une documentation technique de haute qualité permet d'offrir une expérience optimale à l'utilisateur et sert également de levier pour les ventes lors du processus de devis. 

Mats : Selon moi, les avantages de la documentation technique sont nombreux, l'un d'entre eux étant la bonne volonté de l'entreprise. Lorsque vous lisez une documentation de qualité, vous vous apercevez qu'il s'agit aussi d'une marque, d'un produit ou d'une entreprise digne de confiance. Autre avantage de taille : vous n'avez pas besoin d'avoir un service de support conséquent si vous avez une documentation de qualité. Et, en fin de compte, une documentation de qualité améliore la compétitivité de l'entreprise.  

 

Quels sont les avantages pour les utilisateurs finaux ? 

Mats : Avant tout, la facilité d'utilisation. Si vous pouvez utiliser le produit facilement, efficacement et en toute sécurité, c'est un avantage inestimable. 

Karl : L'utilisateur final peut choisir le produit le plus adapté à ses besoins et ensuite l'utiliser de manière optimale. 

 

Qu'est-ce qu'une bonne documentation technique ?

Karl : Pour moi, une bonne documentation technique doit respecter un guide de style et contribuer à atteindre les objectifs généraux de la documentation, qui peuvent être différents selon le secteur d'activité, le sujet traité, etc. Mais le fait de suivre un guide de style qui aide à atteindre ces objectifs est pour moi le facteur clé d'une documentation technique de qualité. 

Concernant les critères, je dirais la lisibilité, qui assure l'utilisation adéquate du contenu, et la traduisibilité. Le contenu est-il élaboré pour faciliter la communication avec des publics internationaux ?  La portabilité est également essentielle. Le contenu est-il suffisamment flexible pour être utilisé sur tous les canaux ? Pouvez-vous partager votre contenu sur les différents canaux où se trouvent vos clients ?  Enfin, autre critère, la réutilisation. Pour tirer le meilleur parti de leur investissement, les entreprises doivent se demander s'il est possible de réutiliser le contenu déjà développé dans des projets ultérieurs. Donc, pour résumer : la lisibilité, la facilité d'utilisation, la traduisibilité, la portabilité et la réutilisation, l'expérience client et l'efficacité des opérations, ainsi que la capacité à communiquer sur différents canaux ou sur tous les canaux. 

Mats : Je pense que la documentation doit être objective et basée sur des faits, et qu'elle ne doit pas contenir d'informations commerciales. Elle doit être facile d'accès et bien structurée, mais aussi facilement compréhensible. Le niveau de langue est lui aussi essentiel. 

 


En savoir plus sur nos services de traduction technique

 

Dans quels secteurs la documentation technique nécessite-t-elle une attention particulière ?

Mats : Cela dépend de la complexité et du niveau de sécurité requis relatif au produit en question. Par exemple, afin qu'elles soient aussi compréhensibles que possible, les informations techniques fournies par IKEA sont totalement dépourvues de mots. 

Selon moi, aucun secteur ne peut se permettre de négliger l'information et la documentation techniques. 

Karl : Par exemple, certains fabricants de logiciels, dont l'API fait partie intégrante de la proposition de valeur du produit, permettent aux clients de développer leurs propres applications en exploitant les interfaces de programmation. Ces fabricants doivent ainsi accorder une attention particulière à la documentation destinée aux développeurs d'API, car elle est l'essence même du produit. Il est donc crucial d'aider les clients, les développeurs à utiliser efficacement le produit. De ce fait, la documentation relative à l'API doit faire l'objet d'une attention accrue. 

N'oublions pas non plus les industries réglementées, comme l'industrie des équipements. Elles doivent accorder une attention particulière à l'information technique et à la traduction, notamment pour la documentation relative à la responsabilité du fabricant. Ces industries sont en effet soumises à des règles juridiques. 


Par exemple, l'industrie des équipements est régie par l'une des principales
législations sur l'harmonisation des exigences essentielles de santé et de sécurité
au niveau européen. Bien sûr, il peut aussi y avoir des réglementations locales qui exigent d'être encore plus attentif vis-à-vis de la documentation technique.

Technical-documentation-illustration-1

Comment les autres services de l'entreprise peuvent-ils aider à la production de la documentation technique ? 

Mats : D'après mon expérience, il est crucial que les autres services de l'entreprise comprennent le rôle et l'importance de la documentation technique, ce qui n'est pas toujours facile. 

J'ai travaillé dans une société de logiciels où les développeurs pensaient avoir atteint leur objectif une fois la solution livrée, qui était simplement destinée à d'autres utilisateurs. Il nous a fallu beaucoup de temps pour leur faire comprendre l'importance de l'information technique et d'un support en arrière-plan. 

Quant aux rédacteurs techniques, ils ont parfois des questions complexes ou nombreuses, et certaines peuvent sembler évidentes. Mais il est essentiel que les experts y apportent des réponses afin que les rédacteurs s'en servent pour créer une documentation technique de qualité. 

La terminologie est une autre composante clé. Dans une entreprise indépendante de son secteur, les rédacteurs techniques sont souvent en bout de chaîne. Prenons l'exemple d'une société avec des concepteurs et des acheteurs, où ces derniers décident d'un terme spécifique pour un produit ou une partie d'un produit. Il se peut alors que les concepteurs et les acheteurs désignent cette même partie avec un terme différent. 

Résultat ? La partie porte différents noms selon les systèmes. Le rédacteur technique doit donc s'efforcer d'utiliser une terminologie cohérente, ce qui peut s'avérer très difficile. 

Dans un monde idéal, le rédacteur technique doit donc être intégré aux processus d'achat et de conception afin de décider de la terminologie à utiliser. Il serait largement préférable que les utilisateurs finaux n'aient pas deux, trois ou cinq synonymes pour le même mot. 

Karl : La production de la documentation technique nécessite un véritable engagement. L'élaboration de méthodes préférentielles est un sport collectif. Vous pouvez organiser des événements pour voir à quoi ressemble une expérience de déballage exceptionnelle ou le développement d'une méthodologie. Travailler en équipe avec un rédacteurs techniques pour s'assurer que la documentation est optimale, puis fournir un retour rapide : voilà certainement ce que souhaite tout rédacteur technique. 

La documentation technique fait partie intégrante du produit ou service, elle est indissociable. Concernant les clients, tous vivent la même expérience.

 

Quels facteurs les entreprises internationales doivent-elles prendre en compte ?  

Mats : Il y a plusieurs choses à prendre en compte, et l'une d'entre elles est la langue. Bien sûr, si vous ne faites pas traduire votre documentation, vous devez vous assurer que le niveau de langue est très simple. Par exemple, dans le secteur aéronautique où j'exerce, nous utilisons généralement l'anglais technique simplifié, qui est une version très simplifiée de l'anglais.  Cela permet aux personnes qui ne maîtrisent pas bien l'anglais de comprendre les instructions. Il est donc plus facile d'utiliser le même langage dans toute la documentation, car cela facilite également la traduction. 

L'accès à internet doit aussi être pris en compte. Nous avons tendance à penser que nous avons accès à internet partout dans le monde, mais c'est faux. Des solutions d'information technique accessibles hors ligne sont donc absolument nécessaires.  

Chaque secteur possède ses propres guides de rédaction, langages simplifiés et structures. Et chacun doit pouvoir y trouver ce qui convient à son entreprise. 

 

Quel est le plus grand défi du secteur de la documentation ? 

Mats : Les défis sont nombreux et, au cours de l'année à venir, je pense que certains d'entre eux prendront la forme de questions. 

Mais l'évolution technique est clairement à la base de tout. En d'autres termes, vous devez disposer de nouvelles plateformes pour diffuser l'information technique, mais aussi être conscient que les jeunes consomment l'information et la documentation techniques différemment. Quand j'étais jeune, nous n'avions d'autre choix que de lire le manuel fourni avec le produit pour utiliser ou réparer un objet. Mais maintenant, nous pouvons utiliser Google. Lorsque vous avez un problème, vous pouvez afficher instantanément la documentation requise pour le résoudre au plus vite. 

Karl : Je constate que les exigences en matière de délais d'exécution évoluent. Beaucoup d'entreprises abandonnent l'exécution en cascade, où l'on travaille sans relâche pendant des mois et des mois, voire des années, avant de lancer le produit sur le marché, au profit du développement agile et des processus agiles. Je constate aussi que le développement de produits s'oriente vers le concept de « produit minimum viable », qui consiste à obtenir un retour sur le produit et à travailler avec les clients pour l'améliorer. De ce fait, les exigences en matière de délais d'exécution s'intensifient. Cela signifie que l'équipe de développement doit désormais diffuser du contenu de manière plus régulière, avec des lots de contenu plus petits et plus fréquents. Le processus de développement ne prend maintenant que quelques semaines, contre quelques mois auparavant. 

C'est donc un véritable défi. La diffusion peut être coûteuse, et c'est un point sur lequel les équipes doivent se pencher : comment réduire les coûts tout en étant capable d'intégrer du contenu en continu pour implémenter les fonctionnalités à mesure que le produit évolue ? 

La transformation agile va au-delà du développement de solutions technologiques. Quel que soit le secteur ou le service, le concept de transformation agile est omniprésent. Par exemple, que ce soit le contenu de formation, la documentation technique, les supports marketing, le web, le commerce électronique, etc., tous sont influencés par la transformation agile. 

 

Qu'en est-il de l'avenir du secteur, quels changements pouvons-nous attendre ? 

Karl : La mise en page est l'un des principaux facteurs de coût : le travail de mise en page des publications est sans fin. Le contenu en tant que service, que l'on peut appeler « CMS headless », est donc l'une des tendances qui se dessinent dans le domaine du e-commerce. Dans le cas où la mise en page est appliquée sur la partie front-end d'une application, qu'il s'agisse d'un centre d'aide, d'un module de formation ou d'une plateforme d'e-commerce, c'est la plateforme qui applique elle-même la mise en page sur le front-end et les développeurs peuvent se concentrer sur le développement du contenu. 

Il ne fait donc aucun doute que le contenu en tant que service et le « CMS headless » s'inscrivent dans une tendance. Au lieu que chaque auteur travaille sur la mise en page dans son environnement de création, le travail de mise en page se fait maintenant en aval du processus. 

Autre tendance : la source unique de contenu, c'est-à-dire la réutilisation du contenu dans le cadre d'initiatives de développement de produits ou de services. Les entreprises cherchent à tirer parti de leur investissement dans les contenus : exploiter encore et encore les actifs numériques qui ont été développés, qu'il s'agisse de systèmes de gestion de contenus, de systèmes de gestion de la traduction ou de bases de données communes. Je ne parlerais pas d'une tendance de 2021, mais plutôt d'un mouvement qui dure depuis plus de dix ans. 

La troisième tendance consiste à promouvoir l'IoT pour les objets informationnels, c'est-à-dire la migration des produits et services dans le cloud. L'abandon du papier au profit de solutions numériques est certainement l'avenir du secteur. 

Enfin, quatrième tendance, l'internationalisation : les produits deviennent connectés et le marché se mondialise. Il est possible d'atteindre des clients dans toutes les régions du monde. 

Mats : L'un des objectifs que nous nous sommes fixés pour les années à venir est de comprendre les changements et défis que nous réserve l'avenir. Les nouveaux mots à la mode comme l'intelligence artificielle, la réalité augmentée, la réalité virtuelle et les jumeaux numériques suscitent beaucoup de discussions. 

Il n'est pas facile d'anticiper l'impact de ces tendances sur le besoin d'informations techniques et sur les méthodes de production et de consommation de l'information et de la documentation techniques. Je ne crois pas qu'il s'agisse de quelque chose d'isolé, mais plutôt d'un ensemble de nouvelles technologies différentes et d'une évolution plus rapide que nous devons suivre.

 

Qu'est-ce que la BOTI ? 

En bref, la BOTI est un lieu de rencontre où les entreprises suédoises peuvent collaborer afin d'obtenir de meilleures informations techniques. La BOTI soutient la qualité de l'information technique dans les entreprises suédoises, dans toutes les langues, et bien sûr dans les traductions. 

Les rédacteurs techniques, ou les services d'information technique, ne représentent souvent qu'une infime portion de l'entreprise. Parfois, une entreprise de 100 salariés ne compte qu'un seul rédacteur technique. Il n'est donc pas facile pour lui de faire valoir son expertise et de s'améliorer s'il est seul et n'a personne pour l'accompagner. C'est pourquoi nous pensons qu'il est crucial que l'organisation soutienne l'entraide, vienne en aide aux entreprises et, bien sûr, fasse avancer le secteur de l'information technique. 

Nous avons beaucoup d'initiatives en cours : nous organisons une conférence une fois par an, ainsi que de nombreux webinaires auxquels tout le monde peut participer gratuitement. Nous avons aussi beaucoup de groupes de travail, qui permettent de discuter avec des personnes issues de différentes entreprises, formant ainsi un réseau très efficace.  

L'objectif de l'organisation est de faire comprendre comment une documentation de haute qualité apporte une valeur ajoutée et comment elle peut accroître la compétitivité des entreprises. 

La langue principale de l'organisation est le suédois, mais tout le monde est le bienvenu. Par exemple, la conférence annuelle et la page web sont en suédois. Pour en tirer le meilleur parti, il est donc utile de maîtriser un minimum cette langue. 

En savoir plus sur la BOTI