Comment créer un outil de création d'aide avec WordPress

Un bon rédacteur technique n'est jamais loin de son outil de création d'aide (HAT).

Le cheval de bataille des rédacteurs techniques - un outil de rédaction d'aide - soulage la pression et transforme l'art de "rendre simple ce qui est complexe"... en un véritable jeu d'enfant.

Les HAT maximisent la productivité des rédacteurs techniques. 10x les rédacteurs techniques sont bien rodés à cet aspect de leur travail.

Avec tant de phases de cycles itératifs de mise en forme et d'édition d'un texte pour qu'il corresponde parfaitement à l'objectif recherché...

...vous avez vraiment besoin d'un HAT qui travaille à vos côtés et vous aide à concentrer tous vos efforts sur la formulation du meilleur produit littéraire.

Le concept de HAT n'est pas nouveau.

Ils existent depuis longtemps.

Et certains diront que s'il s'agissait d'une photo de famille, elle aurait pu être légèrement raturée, sépia et même décolorée.

Par exemple, dans de nombreux cas, la possession d'un éditeur WYSIWYG est considérée comme une fonctionnalité premium.

Mais en réfléchissant plus latéralement, y a-t-il lieu d'appliquer la polyvalence et les multiples avantages transférables d'un système de gestion de contenu (SGC) pour catapulter les HAT dans le 21e siècle ?

Nous dirions que dans le cas de WordPress CMS - la plateforme de création de sites web la plus importante au monde et le logiciel CMS le plus populaire, à des kilomètres à la ronde...

...la réponse est : OUI.

Mais ne vous contentez pas de nous croire sur parole, pourquoi ne pas prendre quelques minutes pour approfondir les raisons pour lesquelles WordPress CMS est la meilleure chose qui puisse arriver aux rédacteurs techniques depuis... pain tranché le café expresso.

Le voici, le guide HeroThemes pour créer un outil d'aide à la rédaction avec WordPress.

Les exigences typiques du rédacteur technique d'aujourd'hui

Aujourd'hui, la rédaction technique couvre de nombreux sujets spécialisés.

• Politique publique gouvernementale
• Informatique I.T.
• Investissements financiers
• Immobilier

... la liste est longue.

Mais les exigences rigoureuses de la traduction de la complexité dans le monde technique sont communes à toutes les tâches quotidiennes.

Selon Khidr Suleman, rédacteur technique, chargé de la conception et de l'assurance des services au sein du service numérique du gouvernement britannique, ses tâches quotidiennes sont les suivantes :

• participer à la recherche sur les utilisateurs
• créer des stratégies de contenu
• présenter des plans aux parties prenantes de haut niveau
• concevoir et prototyper des parcours utilisateurs
• discuter, éditer et (bien sûr) rédiger des contenus

Assez diversifié.

Mais le dernier point de cette liste, et non le moindre, était (bien sûr) de faire ce qu'ils font vraiment.

Mais la rédaction (et en particulier la rédaction technique) est un processus plutôt qu'une activité.

Une course de relais de tâches qui aboutissent collectivement à la livraison de la documentation.

En bref, la rédaction technique peut être décrite comme le processus de "...saisie, organisation et entretien des connaissances sur des systèmes logiciels en évolution rapide" - Atom Bank

C'est pourquoi une journée dans la vie d'un rédacteur technique est souvent marquée par la manipulation de référentiels et de bases de connaissances.

Enregistrer des citations ou des bribes de commentaires d'experts, par exemple. Et récupérer des pépites d'or sous forme de faits ou de données pour valider des arguments.

En bref, la facilité de stockage, de recherche et de localisation ou de découverte des données - outre la rédaction - est également une fonction connexe importante d'un outil de rédaction d'aide.

Qu’est-ce qu’un outil de création d’aide en 2024 ?

Si l'on en croit la majorité des définitions de la page 1 de Google pour l'outil de rédaction d'aide, une description précise devrait inclure :

1. Fabrication
2. Gestion
3. Édition

...documents.

La plupart d'entre eux affirment qu'une meilleure identité serait "système de gestion de contenu".

Il est vrai que ce terme est souvent utilisé dans des articles rédigés par des fournisseurs de CMS (et à cet égard, cet article n'est pas différent), mais si nous examinons la précision de l'utilisation, un CMS est après tout un label approprié pour une HAT.

Il aide littéralement les rédacteurs techniques à rédiger des documents d'aide.

Pour ce qui est de préciser ce que nous entendons par "aide", je suppose qu'il n'y a pas de règles strictes quant à l'étendue de cette aide.

Cela dépend vraiment :

1. Dans quelle mesure les fabricants de logiciels connaissent-ils la discipline de la rédaction technique ?
2. Dans quelle mesure ont-ils été persuadés de répondre au besoin ?

Dans la plupart des cas, la HAT se concentre sur les bases rédactionnelles et éditoriales.

Et offrir un peu de templating, de stylisme et de codage en plus.

Mais la question est de savoir...

...ces fonctions sont-elles suffisantes pour répondre aux exigences élevées du rédacteur technique d'aujourd'hui ?

Pourquoi ne pas demander à quelques-uns d'entre eux ?...

1. Dans cet extrait de retour d'information, le répondant (un rédacteur technique) donne un aperçu comparatif d'une fonctionnalité HAT traditionnelle et d'un CMS traditionnel (Drupal) :

"En tant qu'administrateur dans Drupal, vous pouvez consulter une liste de pages, mais vous ne pouvez modifier les propriétés que d'une seule page à la fois. Il n'y a pas de pas de sélection multiple ni de glisser-déposer.. La gestion des sujets peut donc s'avérer très laborieuse."

"Si vous supprimez une page tous les liens pointant vers elle seront rompuset il n'y a pas de message d'avertissement.

Lorsque vous créez un lien dans une page vous devez connaître le chemin et le nom de la page de destination - il n'y a pas de liste utile des pages disponibles".

"Il n'y a pas d'éditeur WYSIWYG pas d'éditeur WYSIWYG. Pour la majorité des utilisateurs de HAT, c'est une nécessité. Vous ne pouvez écrire votre contenu qu'en html complet/filtré."

(Source : Feuille de Cerise)

2. Dans ce commentaire, un autre rédacteur technique de carrière évoque deux fonctions idéales qui, selon lui, seraient à la mode pour l'avenir des logiciels HAT :

"Recherche ciblée : lorsqu'un utilisateur clique sur l'onglet de recherche et recherche un élément, il peut restreindre les résultats de la recherche. l'utilisateur peut restreindre les résultats de la recherche en utilisant des facettes similaires, comme le montre l'image suivante".

"L'utilisation de n'importe quel outil de création standard - Flare, RoboHelp, Author-It, Doc-to-Help - vous laisse avec le modèle ridicule d'un auteur unique travaillant à partir d'un point de vue unique dans une organisation unique essayant de rassembler un océan d'informations. Ce modèle n'est ni tenable ni évolutif, les HAT disparaîtront au profit de technologies de création collaborative basées sur le web.."

(Source : I'd Rather Be Writing Blog)

Les idées présentées ci-dessus élargissent la portée du sens traditionnel d'un HAT pour inclure une plate-forme plus dynamique et collaborative afin d'améliorer la productivité de la rédaction technique.

Devriez-vous envisager d'utiliser un système de gestion de contenu par composant (CCMS) pour la rédaction d'aide ?

Contrôle des cadeaux de granularité.

Dans le domaine de la rédaction technique, l'avantage d'un meilleur contrôle du cycle de production génère des gains d'efficacité qui se traduisent par un meilleur retour sur investissement du projet.

C'est précisément là qu'intervient un système de gestion de contenu.

Qu'est-ce qu'un système de gestion du contenu des composants (SGCC) ?

Un système de gestion de contenu à composantes est un système de gestion de contenu dont les éléments de contenu ne sont pas des pages ou des billets, mais plutôt des extraits, des paragraphes et des portions de contenu.

De la même manière que lorsque vous produisez un nouveau contenu dans un système de gestion de contenu, vous créez une nouvelle page ou un nouveau message.

Avec un CCMS, vous créez un nouveau composant (partie d'une page ou d'un message).

Une page entière se compose de plusieurs parties, de sorte que le résultat final des pages entières et des messages est le même, mais la façon dont ils sont créés est divisée en petits morceaux.

Pourquoi ?

Economies d'échelle.

Il est vrai qu'il est plus difficile de construire des pages basées sur plusieurs éléments (chacun avec ses propres métadonnées, dépendances, etc.) plutôt que sur un seul élément qui circule librement.

Mais dans le cas de projets de contenu complexes à grande échelle, avec de nombreux croisements thématiques et références internes, la réutilisation et l'interchangeabilité granulaire au niveau des composants...

...un CCMS offre un grand avantage à long terme aux équipes de rédaction.

Il s'agit de faire les choses plus rapidement et avec plus de précision.

Articles de conseils recommandés sur les outils de création d'aide

Le choix de l'outil de création d'aide le mieux adapté ne se résume pas à une simple comparaison des caractéristiques et des avantages.

Pour obtenir le meilleur résultat, vous devez vous plonger dans la convivialité. Comprendre les flux de travail et la gestion des tâches vous aidera à voir les avantages et les inconvénients de chaque solution.

Pour vous aider à obtenir des conseils de vos pairs sur le sujet, nous avons dressé cette liste rapide d'articles utiles sur le chapeau :

1. Pourquoi les chapeaux vont disparaître
2. 5 raisons pour lesquelles je recommande l'utilisation d'un outil de rédaction basé sur l'informatique dématérialisée
3. Qu'est-ce qu'un HAT vous apporte par rapport à Drupal ?
4. 6 raisons d'utiliser le logiciel HAT

Les auteurs des articles ci-dessus s'expriment en toute connaissance de cause sur le sujet de la HAT et donnent un certain nombre de conseils pour prendre la bonne décision.

Quelles sont les principales caractéristiques d'un chapeau ?

Nous affinons donc progressivement notre vision des HAT, de leur rôle et des avantages extérieurs à prendre en compte par rapport à l'approche traditionnelle.

Il serait néanmoins utile de disposer d'une référence complète pour toutes les fonctions d'une HAT.

Nous pouvons ainsi comparer des pommes avec des pommes lorsqu'il s'agit d'un choix d'investissement.

Voici une liste des fonctions les plus courantes et les plus complètes du logiciel HAT :

• Formats d'entrée et de sortie multiples: importation et exportation de données à l'aide de nombreux types de fichiers
• Traitement de texte complet: éditeur WYSIWYG visuel et basé sur le code
• Créer des balises: attribuer des balises thématiques pour relier les articles entre eux.
• Modèles de sujets: prenez de l'avance sur chaque pièce grâce à des modèles préétablis
• Surligneur syntaxique: surlignage utile des problèmes grammaticaux à résoudre
• Balises de fusion pour les méta-informations de l'ensemble du projet: insérez facilement des extraits réutilisables à l'aide de balises de fusion, ce qui permet de gagner du temps et de limiter les erreurs.
• HTML, CSS, Javascript personnalisés : apporter des touches personnalisées à la fonction et à la conception grâce à un code web personnalisé
• Fusionner le contenu d'un projet: combiner le contenu d'un même projet pour produire un résultat mixte.
• Thème web personnalisable: commutateurs, diapositives et cases à cocher pour perfectionner l'interface de l'outil afin d'améliorer l'expérience de l'utilisateur.
• Dépôt de médias: un espace de stockage ordonné pour toutes vos images, PDF, fichiers audio et vidéo.
• Interface utilisateur conviviale: simple à utiliser, toutes les commandes pertinentes étant facilement accessibles et positionnées.
• Traduction: livraison en plusieurs langues
• Table des matières: liens directs faciles à utiliser dans chaque article pour une lecture rapide du contenu.

Parmi les HAT dédiés existants, les points ci-dessus couvrent l'essentiel de ce que l'on peut attendre sous le capot.

Avantages de la fabrication d'un chapeau personnalisé

Si je devais résumer le principal avantage de la fabrication d'un chapeau personnalisé, je dirais :

Maîtrise de sa propre panoplie d'outils.

Un ensemble d'outils sur mesure

Lorsque vous avez "ce que vous voulez", "où et comment vous le voulez" en tant que professionnel, le retour sur investissement en termes de gain de temps et d'amélioration des résultats est incommensurable.

Il n'est tout simplement pas possible de comparer l'expérience d'utilisation d'outils conçus "à la perfection" pour réussir à celle d'un ensemble d'instruments génériques "à faire".

La personnalisation de votre propre chapeau peut donc nécessiter un travail initial considérable et beaucoup d'agitation.

Mais à long terme, le décor est planté pour que vous battiez votre record personnel à chaque projet.

Extensible

Le fait d'attendre les améliorations prévues ou d'être contraint d'opter pour des mises à niveau premium n'a pas lieu d'être avec un chapeau personnalisé.

Bien sûr, vous serez responsable de l'entretien et de l'amélioration de l'outil, mais pour un peu de temps de bricolage, vous pouvez prolonger la durée de vie de votre HAT.

En bref, plus votre HAT s'améliore, plus vos résultats augmentent.

Meilleure performance globale

Une HAT sur mesure éliminera tous les inconvénients mineurs ou gênants de votre flux de travail de rédaction technique.

Vous éliminez tous les goulets d'étranglement et les pertes de temps, en les remplaçant par des fonctionnalités, des options et des configurations qui donnent à votre course à l'achèvement des projets un souffle nouveau.

Vous dépasserez facilement ce que vous pensiez être possible auparavant.

Créer un outil d'aide WordPress avec Heroic Knowledge Base Plugin

Si vous êtes prêt à braver de nouvelles eaux et à vous lancer dans la fabrication de votre propre chapeau, nous avons la solution qu'il vous faut.

Facile à utiliser.

Construit sur une plateforme utilisée par plus de 40 % des sites web en ligne.

Avec toutes les meilleures caractéristiques - et plus encore.

Le voici... notre guide rapide sur la création d'un chapeau avec WordPress.

Et le plus beau, c'est qu'il n'y a pas de code à utiliser. Cette méthode est très conviviale pour les débutants.

Voici le programme :

1. Organisation et catégorisation des pages et des fichiers
2. Recherche, vote, retour d'information et analyse
3. FAQ réplication des composants
4. Logiciel d'assistance pour le traitement des demandes de renseignements par le biais de tickets
5. Table des matières index des pages
6. Glossaire bibliothèque

Un petit point sur "pourquoi WordPress".

Pour la plupart des professionnels, le plus important est de disposer des meilleurs outils pour le travail (quel qu'en soit le nom).

La sémantique ou les injures ne comptent pas beaucoup lorsque l'on s'enfonce dans les produits livrables et que l'on a besoin d'un moteur avec un peu de couple pour s'en sortir.

C'est là que WordPress est la plateforme idéale pour créer un chapeau personnalisé.

Tout d'abord, il remplit toutes les conditions essentielles de la gamme de fonctions mentionnée plus haut dans cet article. Et il le fait avec facilité, dès la sortie de la boîte, avec son offre de base.

Des fonctionnalités telles que WYSIWYG et le codage HTML, CSS et JS sont des fonctionnalités standard offertes par WordPress (le principal système de gestion de contenu au monde).

Mais WordPress est aussi le siège d'une économie de l'hébergement, des plugins et des thèmes qui pèse un demi-billion de dollars.

Ces acteurs sont chargés de fournir les extensions de première classe et l'assistance à la performance qui font de l'outil un outil sur mesure.

Dans l'ensemble, WordPress et ses plugins constituent une équipe de rêve qui offre un chapeau à tout rédacteur technique désireux de créer sa propre installation.

Voici un aperçu des étapes recommandées pour créer votre propre place de marché en ligne à l'aide de WordPress :

Page d'accueil de l'annuaire avec des catégories cloisonnées : une page centrale servant d'index de bibliothèque de référence pour les projets achevés et les ressources recherchées. Une page fourre-tout pour accéder à votre journal de rédaction technique.

Utilisez le plugin Heroic Knowledge Base pour produire une liste automatiquement liée et détaillée de votre contenu HAT précédemment publié.

Heroic Inbox pour traiter les demandes via des tickets : pour traiter facilement les tickets d’assistance aux utilisateurs en vous fournissant un canal d’aide par e-mail réactif qui se trouve dans votre installation WordPress.

Utilisez leHeroic Inbox pour intégrer votre boîte de réception de messagerie professionnelle dans votre tableau de bord d’administration WordPress. Cela vous donne un hub de communications unifiées au sein de votre HAT, ce qui vous permet de perdre du temps autrement consacré à naviguer dans un flux de travail décousu.

Heroic Table of Contents: pour faciliter la lecture écrémée de vos articles, les lecteurs assimilent les informations et en extraient de la valeur. Rendez vos pièces encore plus consommables avec une table des matières classique.

Utilisez leHeroic Table of Contentspour ajouter une table des matières à remplissage automatique à chacun de vos articles.

Heroic Glossary: compilez une liste de A à Z de termes utiles comme raccourci pour accéder aux définitions des mots-clés d’un projet, ce qui vous permet de rester agile tout en rédigeant votre nouveau projet.

UtiliserHeroic Glossary pour installer un glossaire consultable dans votre HAT WordPress – pas de sueur, et (encore) pas de code.

Pour en savoir plus sur le glossaire, consultez notre guide sur la création d'un glossaire avec WordPress.

Aspose.Words : convertissez instantanément les articles ou les pages WordPress en fichiers DOC ou DOCX et vice versa. Comblez les lacunes du flux de travail et rendez votre nouveau système compatible avec les ressources GDocs ou Word Docs existantes.

Utilisez le plugin Aspose.Words pour permettre la conversion bidirectionnelle de fichiers entre WordPress et GDocs ou Word.

Coloration évoluée : mettez en valeur le code Web lorsque vous effectuez des modifications personnalisées, ce qui vous permet de vous concentrer sur les détails sans distraction.

Utilisez Syntax Highlighter Evolved pour embellir le code pendant que vous effectuez vos modifications averties sur le Web.

Conclusion

À l'heure où les CMS sont si perfectionnés, les HAT conçus à cet effet réinventent sans doute la roue.

En fait, il n'y a pas grand-chose (voire rien) que même la HAT la plus avancée puisse faire qu'un CMS avec une certaine configuration ne pourrait pas faire.

De plus, avec un CMS, vous disposez de fonctionnalités supplémentaires qui ajoutent un avantage à une offre déjà compétitive.

Le potentiel supplémentaire offert par un CMS (le leader du marché WordPress avec ses plugins) peut étendre une solution HAT similaire au-delà de vos attentes.

Il y a beaucoup d'espace pour gratter vos propres démangeaisons et continuer à innover avec WordPress - et aucun codage n'est nécessaire.

Un écosystème de plugins tiers en pleine expansion renforce l'avantage de WordPress en termes de parts de marché grâce à des produits spécialisés qui repoussent les limites du possible.

En résumé, nous sommes persuadés que si vous cherchez à investir dans un chapeau personnalisé à l'épreuve du temps, WordPress CMS est la plateforme numérique idéale. Pourquoi ne pas commencer dès aujourd'hui ?