6 Principes de la Rédaction Technique pour Rendre vos Documentations plus Conviviales

6 Technical Writing Principles To Make Your Documentations More User-Friendly

Une documentation conviviale est une victoire pour le rédacteur technique. Mais en créer une peut être difficile, surtout pour un public varié, géographiquement distant, et parlant diverses langues. Voici des principes de rédaction technique qui peuvent vous aider chaque fois que vous essayez d'écrire un matériel d'aide convivial.

Principes de Rédaction Technique pour Créer des Documentations Conviviales

Examinons en profondeur ces principes...

#1. Clarifier les Concepts Compliqués plus que tout

L'une des principales raisons pour lesquelles de nombreux utilisateurs ne lisent pas les fichiers d'aide est le jargon qu'ils contiennent. Ce qui semble n'être qu'une simple terminologie, pour vous le rédacteur technique, peut être l'un des concepts les plus complexes que certains utilisateurs aient jamais rencontré.

Ainsi, si vous avez un procédé ou quelque chose de vraiment compliqué, la meilleure façon de l'expliquer aux utilisateurs est souvent au travers d'exemples. Chaque exemple utilisé peut donner à votre contenu davantage de clarté.

Par exemple, si vous ajoutez trois exemples pour expliquer un concept confus ou une terminologie déconcertante, les utilisateurs le comprendront de façon plus claire que lorsque vous n'en ajoutez qu'un. Cela dit, tous les concepts ou toutes les terminologies n'ont pas d'exemple. Mais rappelez-vous toujours que les exemples sont un outil majeur dans votre trousse d'outils de rédacteur technique pour communiquer des informations complexes de manière plus compréhensible pour les utilisateurs.

#2. Équilibre de Textes et d'Images

Les documentations et manuels d'aide ne doivent pas être ennuyeux. Si vous voulez que vos documentations soient agréables, ajoutez-y des images. Il y a plusieurs options au choix dont des organigrammes, captures d'écran annotées, diagrammes, illustrations ou même juste des photos / images pouvant apporter beaucoup aux documentations.

L'équilibre images et textes fournit un format différent pour la compréhension, connecte au mode d'apprentissage visuel du cerveau humain et se trouve être un guide de référence pour les utilisateurs exécutant des tâches. Certains visuels sont fastidieux à réaliser, mais ils valent absolument la peine.

Cela dit, si vous comptez traduire votre documentation et de manière égale pour toutes les langues, ou si vous voulez vous concentrer davantage sur des échantillons de code que sur du visuel, vous ne vous contenterez que de quelques images dans votre contenu. Mais cela ne veut pas dire qu'il ne faut pas s'efforcer de communiquer avec des images aussi souvent que possible. Rappelez-vous toujours que vous pouvez communiquer avec des éléments visuels pour quasiment tout le monde, même sans textes.

#3. Être le Premier à Expérimenter vos Instructions

Il sera difficile d'apprécier l'aide que vous avez créé à moins de parcourir et effectuer les tâches décrites dans les instructions vous-même. Le test des instructions peut vous sembler évident et ça l'est habituellement avec une documentation graphique. Cependant, dans la réalité, c'est difficile à faire.

Mais il est assez facile de savoir quand un rédacteur technique a écrit une documentation uniquement en fonction des informations reçues de quelqu'un d'autre, plutôt que des informations qu'il a recueillies de son expérience de première main. Faites toujours de votre mieux pour parcourir et essayer vos instructions vous-même.

#4. Travailler avec l'Assurance Qualité pour Obtenir les Scénarios de Test pour lesquelles Documenter

L'équipe de l'Assurance Qualité doit être votre meilleur allié si vous êtes rédacteur technique. Cette équipe a toujours une connaissance du système meilleure que quiconque. Ils ont mis en place les environnements de test pour s'assurer des fonctionnalités et ils sont souvent au fait des situations de test (fonctionnalités à essayer) de chaque version.

Par exemple, si vous documentez sur une API, les ingénieurs de l'Assurance Qualité peuvent se voir demandé des tests dans des formats préconçus. S'appuyer sur les efforts de l'Assurance Qualité peut rendre la rédaction de la documentation beaucoup plus facile.

Néanmoins, dans certains cas, l'Assurance Qualité peut ne pas avoir un meilleur niveau d'information sur les différents scénarios dans lesquels les fonctionnalités seront utilisées. Dans de nombreux cas, ils ne font que tester la fonctionnalité. Vous pourriez avoir à vous référer aux chefs de produit pour avoir une meilleure idée de l'usage de la fonctionnalité. Pourtant, travailler avec votre équipe de l'Assurance Qualité peut davantage faciliter votre travail.

#5. Prendre en compte les retours des utilisateurs dans votre appréciation

Vous devrez obtenir des retours directs des utilisateurs pour comprendre la valeur réelle de vos documentations. Vous ne pouvez pas tirer une conclusion logique basée sur des hypothèses. Que les utilisateurs comprennent la documentation ou pas, qu'elle réponde à leurs besoins et autres, ça reste vraiment une supposition à moins d’obtenir des retours plus tangible du public cible qui utilisera les manuels d'aide.

En savoir plus sur l'analyse de la cible dans la rédaction technique et comment bien la faire.

Parce qu'il est nécessaire de prendre en compte les commentaires des utilisateurs, vous devriez envisager d'avoir des interactions (même directement si possible via un centre d'appel, un réseau social ou un forum) pour bien évaluer le document d'aide. Toujours se rappeler qu'il est difficile d'évaluer votre fichier d'aide grâce à votre seule expérience. C'est l'une des 5 compétences essentielles dont vous avez besoin pour devenir un excellent rédacteur technique.

Et même si vous avez testé toutes les instructions et vérifié qu'elles fonctionnent, vous êtes peut être très familier avec les instructions et les réalisez facilement. Vous avez peut-être loupé de nombreuses informations ou vous avez mal interprété les plates-formes de déploiement, scénarios, etc.

#6. Publier vos documents dans des formats conviviaux

Ne limitez pas votre matériel d'aide à un ou deux formats. Les utilisateurs ayant souvent accès à divers appareils et systèmes d'exploitation. Pour commencer, découvrez les 7 meilleurs formats pour publier votre matériel d'aide.

Vous pouvez utiliser un outil de création d'aide comme HelpNDoc pour rédiger la documentation et publier votre contenu dans différents formats, dont les fichiers d'aide Windows CHM, la documentation web, les sites web pour iPhone, les documents PDF et Word imprimables, ainsi que les livres électroniques ePub et Kindle et fichiers d'aide multi-plateformes Qt. Le meilleur, HelpNDoc est gratuit pour un usage personnel et à des fins d'évaluation.

Aimez documenter !