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

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

Le cheval de bataille du métier de la rédaction technique - un outil d'aide à la création, prend la pression et transforme l'art de «rendre les choses complexes simples»… eh bien, un jeu d'enfant.

Les HAT sont des maximisateurs de productivité pour les rédacteurs techniques. Les rédacteurs techniques 10x ont fermement défini ce côté de leur jeu.

Avec autant de phases de cycles itératifs de mise en forme et d'édition de la copie pour qu'elle soit parfaitement adaptée à l'objectif…

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

Le concept de HAT n'est pas nouveau.

Ils sont passés par là.

Et certains pourraient dire que s'il s'agissait d'une photo de famille, elles auraient pu devenir légèrement écornées, sépia et même s'estomper.

Par exemple, dans de nombreux cas, posséder un éditeur WYSIWYG est considéré comme une fonctionnalité premium.

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

Nous dirions, dans le cas de WordPress CMS - la première plate-forme de création de sites Web au monde et le logiciel CMS le plus populaire à un kilomètre du pays…

…la réponse est oui.

Mais ne vous contentez pas de nous croire sur parole, pourquoi ne pas prendre les prochaines minutes pour approfondir un peu pourquoi WordPress CMS est la prochaine meilleure chose à faire pour les rédacteurs techniques depuis le café expresso en tranches de pain .

Le voici, le guide HeroThemes pour créer un outil de création d'aide à l'aide de WordPress.

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

La rédaction technique couvre aujourd'hui de nombreux sujets spécialisés.

• Politique publique gouvernementale
• Informatique informatique
• Investissement financier
• Immobilier

…la liste continue.

Mais les exigences rigoureuses d'être des traducteurs de la complexité au monde technique sont communes partout sont les tâches quotidiennes.

Selon Khidr Suleman, rédacteur technique, conception et assurance des services au service numérique du gouvernement britannique, voici ses tâches quotidiennes :

• participer à la recherche d'utilisateurs
• créer des stratégies de contenu
• présenter des plans aux principaux intervenants
• conception et prototypage de parcours utilisateurs
• discuter, éditer et (bien sûr) écrire du contenu

Assez diversifié.

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

Mais l'écriture (et en particulier l'écriture technique) est un processus plutôt qu'une activité.

Une course de relais de tâches qui mènent collectivement à la remise de documents.

En un mot, la rédaction technique peut être décrite comme étant le processus de "... capture, organisation et maintenance des connaissances sur les systèmes logiciels en évolution rapide" - Atom Bank

Et en tant que tel, une caractéristique commune d'une journée dans la vie d'un rédacteur technique est la gestion des référentiels et des bases de connaissances.

Enregistrer des citations ou des extraits de commentaires d'experts, par exemple. Ainsi que la récupération de pépites d'or sous forme de faits ou de données pour valider les arguments.

En bref, la facilité de stockage des données, la recherche et la localisation ou la découverte - en dehors de l'écriture - sont également des fonctions alliées importantes d'un outil de création d'aide.

Qu'est-ce qu'un outil de création d'aide en 2022 ?

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

1. Fabrication
2. Gérant
3. Édition

… documents.

La plupart prétendent qu'une meilleure identité serait «système de gestion de contenu».

Certes, ce terme a tendance à être inclus dans les articles écrits par les fournisseurs de CMS (et à cet égard, cet article ne serait pas différent), mais si nous examinons l'exactitude de l'utilisation - un CMS est après tout une étiquette appropriée pour un HAT.

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

En ce qui concerne la définition précise de ce que nous entendons par aide, je suppose qu'il n'y a pas de règles strictes quant à la portée de cette aide.

Cela dépendrait vraiment de :

1. Dans quelle mesure les fabricants de logiciels connaissent-ils la discipline de rédaction technique ?
2. À quel point ils étaient convaincus de répondre au besoin

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

Et offrez un peu, des modèles, du style et du codage en plus.

Mais la question est…

… Ces fonctions suffisent-elles à elles seules à répondre aux exigences élevées du rédacteur technique moderne ?

Pourquoi ne pas en demander quelques-unes ?…

1. Dans cet extrait de commentaires, le répondant (un rédacteur technique) donne un examen comparatif d'une fonctionnalité HAT traditionnelle par rapport à un CMS traditionnel (Drupal) :

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

"Si vous supprimez une page, tous les liens pointant vers elle seront rompus et aucun message ne vous avertira.

Lors de la création d'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 listes utiles de pages disponibles.

"Prêt à l'emploi, il n'y a pas d'éditeur WYSIWYG . Pour la majorité des utilisateurs de HAT, c'est un must. Vous ne pouvez écrire votre contenu qu'en html complet/filtré.

(Source : feuille de cerisier)

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

"Recherche factuelle : lorsqu'un utilisateur clique sur l'onglet de recherche et recherche un élément, l' utilisateur peut affiner les résultats de la recherche en utilisant des facettes similaires, comme indiqué dans l'image suivante."

"L'utilisation de l'un des outils de création standard - Flare, RoboHelp, Author-It, Doc-to-Help - vous laisse avec le modèle ridicule d'un seul auteur travaillant à partir d'un point de vue unique à partir d'une seule organisation essayant de rassembler un océan de information. Parce que ce modèle est intenable et non évolutif, les HAT disparaîtront au profit des technologies de création collaboratives basées sur le Web .

(Source : Je préférerais écrire un blog)

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

Devriez-vous envisager d'utiliser un système de gestion de contenu de composants (CCMS) pour la création d'aide ?

Contrôle des cadeaux de granularité.

Et dans le domaine de la rédaction technique, l'avantage d'un meilleur contrôle au sein du cycle de production engendre des gains d'efficacité qui se traduisent par un retour sur investissement plus important du projet.

C'est exactement là qu'intervient un système de gestion de contenu de composants.

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

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

De la même manière, lorsque vous venez de produire un nouveau contenu dans un CMS, vous démarrez une nouvelle page ou un nouveau message.

Avec un CCMS, vous commenceriez un nouveau composant (partie d'une page ou d'un article).

De nombreuses portions forment une page entière, de sorte que le résultat final de pages entières et de publications est le même, mais la façon dont elles sont créées est divisée en petits morceaux.

Pourquoi?

Économies d'échelle.

Bien sûr, il est sans doute plus difficile de créer 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 fluide.

Mais, avec des projets de contenu complexes à grande échelle avec beaucoup de croisements thématiques et de références internes, la réutilisabilité et l'interchangeabilité granulaire au niveau des composants…

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

À savoir, faire avancer les choses plus rapidement et avec plus de précision.

Articles de conseils sur l'outil de création d'aide recommandés

Le choix de l'outil de création d'aide le mieux adapté est plus qu'une simple comparaison des « fonctionnalités et avantages ».

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

Pour vous aider dans certains avis recommandés par des pairs sur le sujet, nous avons rassemblé cette liste rapide d'articles utiles liés à HAT :

1. Pourquoi les HAT vont s'estomper
2. 5 raisons pour lesquelles je recommande d'utiliser un outil de création basé sur le cloud
3. Que vous apporte un HAT par rapport à Drupal ?
4. 6 raisons d'utiliser le logiciel HAT
5. 5 types d'outils de création utilisés par les rédacteurs techniques

Les auteurs des articles ci-dessus parlent assez bien du sujet de la HAT et donnent un certain nombre de conseils sur la bonne voie pour prendre la bonne décision.

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

Ainsi, nous raffermissons progressivement notre point de vue sur les HAT, ce qu'ils font et les avantages extérieurs que nous devons considérer en plus de l'approche traditionnelle.

Mais cela vaudrait toujours la peine d'avoir une référence complète pour toutes les choses qu'un HAT déo.

De cette façon, nous pouvons comparer « des pommes pour des pommes » lorsque nous envisageons un choix d'investissement.

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

• Plusieurs formats d'entrée et de sortie : importez et exportez des données à l'aide de nombreux types de fichiers
• Traitement de texte complet : éditeur WYSIWYG basé sur le code et visuel
• Construire des balises : attribuez des balises thématiques pour relier les articles de manière thématique
• Modèles de sujet : prenez une longueur d'avance sur chaque élément avec des modèles prédéfinis  
• Surligneur de syntaxe : surligneurs utiles sur les problèmes grammaticaux à résoudre  
• Balises de fusion pour les méta-informations à l'échelle du projet : insérez facilement des extraits de code réutilisables à l'aide de balises de fusion, gain de temps et limitation des erreurs
• HTML, CSS, Javascript personnalisés : appliquez des touches personnalisées à la fonction et à la conception avec un code Web personnalisé
• Fusionner le contenu du projet : combiner le contenu au sein 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 votre expérience utilisateur
• Référentiel multimédia : une zone de stockage soignée pour toutes vos images, PDF, fichiers audio et vidéo  
• Interface utilisateur facile : simple à utiliser avec toutes les commandes pertinentes à distance et positionnement faciles à atteindre  
• Traduction : livraison en plusieurs langues
• Table des matières : liens de saut faciles à utiliser dans chaque article pour une lecture rapide du contenu  

Parmi les HAT dédiés, les points ci-dessus couvrent la majeure partie de ce à quoi on pourrait s'attendre sous le capot.

Avantages de la construction d'un HAT personnalisé

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

Maîtrise de votre propre ensemble d'outils.

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 temps gagné et en résultats améliorés est incommensurable.

Vous ne pouvez tout simplement pas comparer l'expérience de l'utilisation d'outils conçus « parfaitement » pour le succès par rapport à un ensemble d'instruments génériques « à faire ».

Ainsi, la personnalisation de votre propre HAT peut impliquer un travail initial et des tracas considérables.

Mais à long terme, la scène est prête pour que vous battiez votre record personnel à chaque projet.

Extensible

Il n'est pas nécessaire d'attendre des améliorations planifiées ou d'être contraint à des mises à niveau premium avec un HAT personnalisé.

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

En bref, à mesure que votre HAT s'améliore, vos résultats s'améliorent également.

Meilleure performance globale

Un HAT personnalisé supprimera tous les désagréments mineurs ou obstructifs de votre flux de travail de rédaction technique.

Vous supprimez tous les goulots d'étranglement et les pertes de temps, en les remplaçant par des fonctionnalités, des options et des configurations qui donnent à votre course aux projets de finition un vent suivant.

Vous obtiendrez facilement ce que vous pensiez être possible auparavant.

Création d'un outil de création d'aide WordPress avec le plugin Heroic Knowledge Base

Donc, maintenant, si vous êtes prêt à braver de nouvelles eaux et à vous lancer dans la fabrication de votre propre HAT, nous avons la solution pour vous.

Facile à utiliser.

Construit sur une plate-forme utilisée par plus de 40 % de tous les sites Web en ligne.

Avec toutes les meilleures fonctionnalités - et plus encore.

Le voici… notre guide rapide sur qui faire un HAT en utilisant WordPress.

Et la meilleure partie est qu'il n'y a aucun code impliqué du tout. Cette méthode est très conviviale pour les débutants.

Voici la liste :

1. Organisation et catégorisation des pages et des fichiers
2. Recherche, vote, commentaires et analyses
3. FAQ réplication de composants
4. Helpdesk pour le traitement des demandes via des tickets
5. Index des pages de la table des matières
6. Bibliothèque de termes de glossaire

Un petit point sur « pourquoi WordPress ».

Pour la plupart des professionnels, disposer des meilleurs outils pour le travail (quel que soit son nom) est la chose la plus importante.

La sémantique ou les injures ne comptent pas beaucoup car vous devenez imprégné de livrables et avez besoin d'un moteur avec un certain couple pour vous déterrer.

C'est là que WordPress est idéal comme plate-forme pour créer un HAT personnalisé.

Tout d'abord, il coche toutes les cases essentielles de la liste des fonctions mentionnées plus haut dans cet article. Et il le fait facilement, 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 proposées par WordPress (le premier système de gestion de contenu au monde).

Mais WordPress héberge également une économie d'hébergement, de plugins et de thèmes d'un demi-billion de dollars.

Ces acteurs sont chargés de fournir les extensions de première classe et l'assistance aux performances qui font de l'outil un outil personnalisé.

Dans l'ensemble, WordPress et ses plugins compagnons constituent une équipe de rêve offrant un HAT à tout rédacteur technique souhaitant bricoler sa propre configuration.

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

Page d'accueil de l'annuaire avec catégories cloisonnées : une page centrale servant d'index de bibliothèque de référence des projets terminés et des ressources recherchées. Un emplacement fourre-tout soigné 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é.

Recherche, vote, commentaires et analyses : prenant note de l'appel à la collaboration de nos auteurs techniques contributeurs du début de l'article, nous avons intégré le dynamisme et l'engagement dans les fonctionnalités de notre solution WordPress HAT. Fournir une recherche, des commentaires et des idées ne fera que contribuer à développer de plus grandes améliorations.

Utilisez le plug-in Heroic Knowledge Base pour activer les améliorations de la recherche utilisateur afin de diriger une feuille de route d'amélioration itérative pour le produit.

Réplication de composants FAQ : configurez un contrôle granulaire des composants sur les questions fréquemment posées, en vous donnant l'avantage d'avoir une production allégée pour faire évoluer des projets plus importants.

Utilisez le plugin Heroic FAQs pour équiper votre HAT avec des composants réutilisables intégrés avec une installation simple et un séro-code.

Boîte de réception héroïque pour le traitement des demandes via des tickets : pour traiter facilement les tickets d'assistance aux utilisateurs, vous offrant ainsi un canal d'aide par e-mail réactif qui se trouve dans votre installation WordPress.

Utilisez le plugin Heroic Inbox pour intégrer votre boîte de réception 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 fait gagner du temps autrement passé à naviguer dans un flux de travail décousu.

Table des matières héroïque : les liens de saut pour faciliter la lecture rapide de vos articles aident les lecteurs à digérer les informations et à en extraire la valeur. Rendez vos pièces encore plus consommables avec une table des matières classique.

Utilisez la table des matières héroïque pour ajouter une table des matières à remplissage automatique à chacun de vos articles.

Glossaire héroïque : compilez une liste AZ de termes utiles comme raccourci pour accéder aux définitions des mots clés sur un projet, vous gardant agile tout en écrivant votre nouveau projet.

Utilisez le plugin Heroic Glossary pour installer un glossaire consultable dans votre WordPress HAT – sans effort et (encore) sans code.

Aspose.Words : convertissez instantanément les publications 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 héritées.

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

Syntax Highlighter Evolved : faites ressortir le code Web lorsque vous effectuez des modifications personnalisées, vous aidant à vous concentrer sur les détails sans distraction.

Utilisez Syntax Highlighter Evolved pour rendre le code magnifique lorsque vous apportez vos modifications Web avisées.

Conclusion

De nos jours, les HAT spécialement conçus pour ces CMS avancés réinventent probablement la roue.

Il n'y a en fait pas grand-chose (le cas échéant) que même le HAT le plus avancé peut 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 fourni par un CMS (le leader du marché WordPress avec ses plugins) peut étendre une solution HAT similaire au-delà de vos attentes.

Beaucoup d'espace pour gratter vos propres démangeaisons et continuer à innover avec WordPress - plus aucun codage nécessaire.

Un écosystème de plugins tiers en pleine expansion prend en charge l'avantage de la part de marché de WordPress avec des produits spécialisés pour repousser les limites du possible.

Dans l'ensemble, nous sommes convaincus que si vous cherchez à faire un investissement HAT personnalisé à l'épreuve du temps, WordPress CMS est la plate-forme numérique idéale.

Pourquoi ne pas commencer aujourd'hui ?