Free Press

Reprenant où de nous avons laissé dans la partie 1 de la série d’outils de rédaction technique. (Consultez-la si vous ne l’avez pas lue)
Dans ce volet, nous traitons des outils de rédaction technique utilisés dans la phase « Documenter l’information ».
C’est la phase de rédaction, d’édition, de dessin, de révision et de réécriture. C’est la phase où l’équipe de documentation de l’information est à son maximum pour produire des guides, des manuels, des blogs, des démonstrations vidéo, des pages d’aide en ligne, et quoi encore. Étant donné la variété des tâches de cette phase, les outils de rédaction technique employés sont également très divers, et innombrables.

Les 17 meilleurs outils logiciels de rédaction technique pour la documentation en 2020

• • Whatfix
  • MediaWiki

  .

  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator

.

• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix signifie un changement de paradigme dans la façon dont la documentation d’aide est présentée en ligne. Les pages d’aide web statiques et longues n’attirent pas l’attention de l’utilisateur aussi efficacement que les guides interactifs et imagés présentés par Whatfix, populairement appelés « ballons ».
De plus, l’aide en ligne dans le monde d’aujourd’hui doit se répandre sur différents gadgets – qu’il s’agisse de PC, de tablettes ou de smartphones. Whatfix adapte automatiquement le contenu de l’aide en fonction du gadget. Et le même contenu d’aide peut être accessible sous différentes formes – comme un diaporama, un PDF ou une vidéo.
Conseil de l’auteur : Whatfix prend en charge une fonctionnalité unique – Real-time Interactive walkthrough – dans laquelle vous mettez vos extraits d’aide directement dans la page produit en direct ! L’utilisateur lit le snippet dans la bulle Whatfix et effectue l’action correspondante sur la page. C’est un outil de rédaction technique populaire parmi les entreprises qui cherchent à s’éloigner des méthodologies traditionnelles.

MediaWiki

Afficher l’aide en ligne de votre produit sous forme de pages wiki est une idée simple et efficace. Vos pages peuvent être intégrées directement dans Wikipédia si vous ne disposez pas d’un site Web distinct pour votre produit en ligne. Vous pouvez également héberger des pages d’aide de type wiki sur le site Web de votre produit. La grande familiarité de ce format parmi les utilisateurs en ligne est un avantage clé, et l’outil d’édition wiki gratuit MediaWiki Visual Editor rend la création d’aide assez simple.
MediaWiki est un outil d’édition web basé sur PHP, que Wikipedia utilise. Cependant, même les grandes sociétés de logiciels, Intel étant un exemple clé, utilisent cet outil pour présenter leurs informations de vente et de marketing, les How To’s, et les pages d’aide sur la politique et les procédures.
Conseil de l’auteur : Cet outil de rédaction technique est livré avec un bon support pour les extensions – pour le contenu multilingue, la révision collaborative, le suivi des modifications, la recherche intégrée, etc.

Adobe RoboHelp

Outil auteur standard de l’industrie utilisé pour créer des systèmes d’aide pour les applications de bureau ou Web. Aucun utilisateur d’ordinateur n’est étranger à RoboHelp ! Chaque fois que vous appuyez sur la touche F1 dans l’une de vos applications logicielles standard, la fenêtre d’aide qui apparaît est presque toujours créée à l’aide de RoboHelp. Cependant, il peut également être utilisé pour produire de la documentation technique conventionnelle destinée à être imprimée, comme des guides et des manuels.
L’IDE sophistiqué de RoboHelp permet aux rédacteurs techniques de développer des projets d’aide à grande échelle et de les rendre sur plusieurs périphériques matériels/systèmes d’exploitation, et dans plusieurs formats (PDF, HTML, DOC, etc.). La version plus ancienne de RoboHelp peut être achetée en tant qu’édition à bas prix si le budget est une contrainte. Cependant, les petites entreprises peuvent s’en tenir à des alternatives simples et gratuites telles que les blogs WordPress ou les Wikis. Le bon vieux MS Word peut également générer des fichiers d’aide HTML de base pour vous.
Conseil de l’auteur : La gestion de grands produits logiciels avec des versions de mise à jour régulières peut constituer un défi majeur pour les rédacteurs techniques, car ils doivent être en phase avec l’historique des modifications du produit. Les fichiers d’aide présentent souvent des variables configurables définies par l’utilisateur qui sont répétées plusieurs fois dans la documentation d’aide. (Par exemple, une variable telle que « Temps de veille après inactivité » est définie à 30 secondes dans la version précédente, pour être définie à 1 minute dans la mise à niveau). Le projet RoboHelp se chargerait de mettre à jour la valeur de la variable tout au long des fichiers d’aide !

Notepad++

Un éditeur HTML pour débutants très efficace. La plupart des gens apprennent les bases de la programmation HTML sur cet outil de rédaction technique. Si votre produit logiciel ne nécessite pas une documentation d’aide en ligne très lourde, pour faire des fichiers d’aide de taille moyenne, cet outil est plus que suffisant.
Son interface graphique personnalisable permet une édition facile, il prend en charge le WYSIWYG pour l’impression et dispose également d’options de support multi-langues.
Conseil de l’auteur : Notepad++ est livré avec un riche ensemble de plug-ins. Multi-clipboard, Code Compare, Auto-Save sont quelques uns des plus populaires. Les rédacteurs techniques doivent choisir le bon ensemble de plug-ins, qui peuvent transformer un éditeur ordinaire pour débutants en une option viable pour l’édition d’aide en ligne.

WordPress

Le lieu GoTo si vous voulez avoir une documentation technique pour votre produit sous forme de blogs. WordPress est une plateforme de gestion de contenu en ligne, gratuite et open source. Les blogs écrits sur WordPress peuvent soit être accessibles directement à partir de l’URL du blog WordPress, soit être intégrés au site Web de votre entreprise.
Cet article lui-même est hébergé sur le blog WordPress appelé Whatfix Academy. Si l’objectif est de publier régulièrement du contenu en ligne sur votre entreprise/les technologies associées, alors créez un compte de blog WordPress. Les blogs peuvent également capturer les réponses des utilisateurs sous forme de commentaires et de likes, ce qui permet de s’engager plus facilement avec votre public cible et de sentir leur appréciation de votre produit.
Conseil de l’auteur : Les blogs isolés peuvent ne pas rassembler suffisamment d’oculaires. Donc, écrivez votre blog d’abord, faites-en la promotion sur les plateformes de médias sociaux ensuite et enfin mesurez le nombre de spectateurs/réponses avant de passer à la prochaine série de blogs !
Aussi lu : Comment la rédaction technique évolue avec le temps

Adobe Photoshop

Un outil que la plupart des rédacteurs techniques à travers l’industrie ne jurent que par lui. C’est l’outil d’édition d’images le plus populaire au monde pour créer et éditer des photos et des œuvres d’art basées sur des trames (pixels). Il peut être utilisé pour créer des conceptions d’interface utilisateur, des pages Web, des bannières publicitaires, des graphiques vidéo et pour éditer des images pour l’impression. La manipulation d’une image, la superposition d’une image sur une autre, l’affinage d’une photographie pour éliminer les imperfections, la correction des problèmes d’éclairage sont ses utilisations les plus courantes. Le processus d’édition d’images est réversible et incrémentiel, de sorte que les changements peuvent être facilement annulés.
Conseil de l’auteur : Pour les concepteurs professionnels, qui ont constamment besoin d’un outil d’édition d’image, il n’y a presque aucun remplacement à Adobe Photoshop. Cependant, si vous êtes un utilisateur occasionnel, essayez GIMP qui est open source. Il ne prend en charge que les schémas de couleurs RVB, alors que Photoshop prend également en charge le mode de couleurs CMYK (CYAN YELLOW MAGENTA BLACK). Et la courbe d’apprentissage est plus élevée pour GIMP, mais il est gratuit alors que Photoshop coûte une bombe !

Adobe Illustrator

Outil de création et d’édition d’illustrations vectorielles telles que des logos et des marques ou d’autres éléments de conception. Les graphistes font souvent l’erreur de concevoir les logos de leurs produits sur Photoshop. Mais ce même logo doit être imprimé sur des cartes de visite, ainsi que sur des panneaux publicitaires massifs. Il est donc essentiel de mettre l’image à l’échelle sans perdre sa clarté, ce que les outils d’imagerie basés sur les graphiques vectoriels permettent de faire. Adobe Illustrator et Corel Draw sont les principaux outils de rédaction technique rédaction technique dans cet espace.
Conseil de l’auteur : Cet outil fait partie de la solution Adobe Creative Cloud avec des locations mensuelles coûteuses. Des outils de rédaction technique alternatifs gratuits comme Inkscape ou Affinity Designer peuvent faire le travail tout aussi bien avec les formats SVG. À moins que vous ayez besoin de tous les principaux outils de rédaction technique qui font partie de cette solution (Photoshop, InDesign, etc.), cet outil n’est pas indispensable.

Microsoft Visio

Un outil de diagramme populaire utilisé dans la conception d’applications d’ingénierie. Les rédacteurs techniques ont souvent besoin de concevoir des organigrammes, des diagrammes architecturaux, des schémas de circuits électriques, des conceptions de produits logiciels, etc. Visio est une aide pratique pour cela.
C’est un outil de rédaction technique conforme à l’IEEE qui se conforme aux normes de l’industrie logicielle telles que UML (Unified Modeling Language) et BPMN (Business Process Model and Notation).
Conseil des auteurs : Visio n’a pas fait partie de la suite traditionnelle de Microsoft Office, a toujours été vendu séparément comme MS Project. Mais une annonce très récente de Microsoft indique que les abonnés en ligne d’Office 365 peuvent maintenant accéder à Visio également.

Windows Snipping Tool

Si vous recherchez des options de capture d’écran plus sophistiquées que PrntScr sur votre clavier, Snipping Tool est un bon choix. Outre la capture en plein écran, vous pouvez également capturer des coupes à main levée, ou des coupes de zones partielles de l’écran. Pour capturer des images fixes à partir de vidéos, utilisez l’option de retardement afin que l’image exacte puisse être enregistrée en tant qu’image.
Conseil aux auteurs : Il fait partie de la suite de logiciels Windows, mais peut ne pas être activé par défaut dans certaines éditions de Windows.

Windows Movie Maker

Un outil d’édition vidéo simple que les rédacteurs techniques peuvent utiliser pour réaliser leurs vidéos de démonstration de produits. Il fait partie de la suite Windows Essentials. Cependant, depuis janvier 2017, ce logiciel a été abandonné, sans l’annonce d’un véritable remplacement. Alors, tous les utilisateurs de versions antérieures de Windows, remerciez votre bonne étoile !
Conseil aux auteurs : Les vidéos et les coupures audio peuvent être organisées et éditées dans une vue storyboard, image par image. Ou encore, une série d’images fixes peut être étirée sur une ligne de temps. Des voix off audio maillées avec des sons de fond peuvent donner à vos vidéos un avantage sophistiqué.

Powtoon

L’écriture technique devient de plus en plus visuelle. Les vidéos animées sont un excellent moyen de capter l’attention des utilisateurs et de faire passer le message de manière engageante. Powtoon est un bon outil d’animation basé sur le Web, vendu en tant que produit SaaS. Des présentations animées et des vidéos explicatives peuvent être créées gratuitement à l’aide de cet outil. Toutefois, les vidéos créées avec la version gratuite porteront un filigrane « Powtoon ».
Conseil aux auteurs : si la rédaction technique n’est pas à des fins officielles, il est parfaitement acceptable d’utiliser la version gratuite de cet outil. Cependant, une location nominale, vous pourriez obtenir la version premium qui vous permet de créer des vidéos sans filigrane et plusieurs autres fonctionnalités.

Prezi

Une prise non conventionnelle pour faire des démos sous la forme d’une présentation vidéo. Contrairement à Powerpoint, où le contenu est rigidement divisé en diapositives, Prezi vous donne juste une toile blanche massive. Vous pouvez écrire et dessiner dessus comme bon vous semble. Faire un zoom avant ou arrière sur le contenu en cours et passer d’une image à l’autre sur la même toile – c’est ainsi que vous faites une présentation vidéo continue.
Conseil des auteurs : En dehors de la version gratuite, il existe une version d’essai pour les étudiants qui est également gratuite et qui possède presque toutes les fonctionnalités de la version payante. Choisissez celle-là.
Lisez aussi – 14 idées fausses sur la rédaction technique que vous devriez connaître !

Microsoft Word

Il est vrai que cela semble plutôt idiot d’écrire sur l’omniprésent MS Word. Mais aussi banal qu’il soit dans notre vie numérique quotidienne, il se trouve être le meilleur ami du rédacteur technique ! Avec une conversion facile entre les formats PDF et DOC, la simple combinaison de Word et d’Adobe Acrobat Reader n’est pas à prendre à la légère. Cet article pourrait porter sur tous les outils de rédaction technique sophistiqués du monde, mais il est écrit en utilisant – l’humble MS Word !
Conseil aux auteurs : Expérimentez les différents modèles de documents proposés par Word. Ils aident à rendre votre document approprié à l’objectif visé – comme des prospectus de marketing, des livres blancs techniques, des guides de dépannage, et ainsi de suite.

Kingsoft WPS Office

MS Word, PowerPoint et Excel sont connus pour être les outils logiciels de rédaction technique les plus utilisés, à des kilomètres devant les alternatives disponibles. Seule la révolution Android a un peu ralenti le juggernaut MS Office. Et donné une place de choix à Kingsoft Office, une alternative raisonnable et gratuite à MS Office.
Conseil des auteurs : Il y a quelques fonctionnalités nuancées que WPS Writer ne prend pas en charge – le thésaurus étant l’une d’entre elles. Le thésaurus est une fonctionnalité importante pour les rédacteurs techniques, car nous sommes constamment à la recherche de meilleurs mots pour exprimer les mêmes points dans différents documents techniques !

Google Docs

Dans un monde qui se tourne de plus en plus vers un téléphone portable pratique pour lire des documents, plutôt que de prendre la peine d’allumer l’ordinateur, google docs en gagnant lentement en importance. La création de documents à partir de zéro ne serait pas pratique sur Google Docs, mais la révision et l’édition collaborative peuvent être effectuées efficacement grâce à cette alternative à MS Office basée sur le cloud.
Conseil de l’auteur : son intégration transparente avec Gmail et Google Drive le rend encore plus attrayant. En tant que rédacteur technique, vous vous en tiendriez aux outils de traitement de texte sophistiqués. Mais votre chef de produit qui pourrait être en déplacement tout le temps est sûr de rattraper ses révisions sur son téléphone, selon toute probabilité !

Adobe Framemaker

Un processeur de documents sophistiqué pour les documents volumineux, aux normes industrielles. Peut être utilisé pour générer des documents structurés avec un cadre XML, avec une conformité 100% DITA. Peut être utilisé pour les documents non structurés également, en remplacement des éditeurs de documents comme MS Word.
Framemaker est un bon choix pour générer des documents structurés avec des modèles prédéfinis pour se conformer à plusieurs formats standards industriels – tels que les accords juridiques et les états financiers. Il prend en charge la création de COT ou d’index sur plusieurs documents, dispose d’options de formatage riches. Ses performances ne faiblissent pas lorsque des graphiques sont insérés.
Conseil de l’auteur : Framemaker est un investissement judicieux pour les entreprises établies disposant d’équipes de rédaction technique formelles et devant produire des documents volumineux de plus de 100 pages. Cependant, les entreprises à produit unique et les startups n’ont pas besoin de faire cet investissement. Il existe des outils gratuits de création de documents basés sur XML. Et vous pouvez toujours vous rabattre sur le bon vieux MS Word !

oXygen XML Author

C’est un éditeur XML gratuit et open source conforme à la norme DITA, avec plusieurs utilisateurs fidèles et de bonnes critiques. La DITA (Document Information Typing Architecture) est un standard ouvert pour la création et la publication de documents qui a lentement fait son chemin dans la gestion des documents techniques. Tout simplement parce qu’elle supprime la dépendance de l’édition de contenu à un outil particulier. Vous barattez une documentation en ligne conforme à la DITA (un ensemble de fichiers XML), puis son édition et sa maintenance à l’avenir seraient possibles grâce à n’importe quel autre outil conforme à la DITA !
Puisque les spécifications de la DITA sont un domaine qui nécessite une attention particulière, laissez-moi garder cela pour un autre article.
Conseil de l’auteur : Il suffit de dire que la suite d’outils oXygen est une alternative viable à l’immensément populaire mais au coût prohibitif d’Adobe Framemaker. oXygen Author est généralement utilisé en combinaison avec oXygen Developer.
C’est donc tout le logiciel de rédaction technique dont vous aurez besoin dans la phase « Information sur le document ». La prochaine et dernière partie présentera la phase « Publier l’information ».
Pour apprendre d’excellents conseils de rédaction technique et pour vous assurer de ne pas manquer nos mises à jour sur les outils de rédaction technique, abonnez-vous à notre blog.
Vous aimez ? Mettez l’article en signet ou partagez-le avec vos amis et collègues !

Nous, à Whatfix, innovons l’espace des outils de rédaction technique en perturbant l’idée même d’un long contenu écrit continu. Nos guides interactifs vous aideront à devenir plus productif en vous fournissant un moyen rapide et efficace de créer de la documentation technique. Lisez plus sur la façon dont Whatfix aide à la rédaction technique dans cet article.