So erstellen Sie ein Hilfe-Autorentool mit WordPress

Ein guter Technischer Redakteur ist nie weit von seinem bewährten Help Authoring Tool (HAT) entfernt.

Das Arbeitspferd der Branche für technische Redakteure – ein Hilfe-Autorentool, nimmt Ihnen die Arbeit und verwandelt die Kunst, „komplexe Dinge einfach zu machen“ … nun, ein Kinderspiel.

HATs sind Produktivitätsmaximierer für Technische Redakteure. 10x Technische Redakteure haben diese Seite ihres Spiels fest im Griff.

Mit so vielen Phasen von iterativen Runden der Gestaltung und Bearbeitung von Texten, um ihn als perfekt für den Zweck geeignet zu landen …

… brauchen Sie wirklich einen HUT, der mit Ihnen zusammenarbeitet und Ihnen dabei hilft, all Ihre Bemühungen darauf zu konzentrieren, das beste literarische Produkt zu formulieren.

Das Konzept eines HUT ist nicht neu.

Sie waren da.

Und einige mögen sagen, wenn es sich um ein Familienfoto gehandelt hätte, wären sie vielleicht leicht mit Eselsohren, Sepia und sogar an Relevanz verloren gegangen.

Beispielsweise wird der Besitz eines WYSIWYG-Editors in vielen Fällen als Premium-Funktion betrachtet.

Aber etwas quer gedacht, gibt es ein Argument dafür, die Vielseitigkeit und die vielfältigen übertragbaren Vorteile eines Content-Management-Systems (CMS) zu nutzen, um HATs ins 21. Jahrhundert zu katapultieren?

Wir würden argumentieren, im Fall von WordPress CMS – der weltweit führenden Webbuilding-Plattform und mit Abstand beliebtesten CMS-Software …

…Die Antwort ist ja.

Aber nehmen Sie uns nicht einfach beim Wort, warum nehmen Sie sich nicht die nächsten Minuten, um ein wenig tiefer in das Thema einzutauchen, warum WordPress CMS das zweitbeste für technische Redakteure seit geschnittenem Brot- Espresso-Kaffee ist.

Hier ist er, der HeroThemes-Leitfaden zum Erstellen eines Hilfe-Authoring-Tools mit WordPress.

Die typischen Anforderungen an den Technischen Redakteur von heute

Die Technische Redaktion umfasst heute viele Fachgebiete.

• Staatliche öffentliche Ordnung
• IT-Computing
• Finanzielles Investieren
• Immobilie

…Die Liste geht weiter.

Allen gemeinsam sind jedoch die strengen Anforderungen, Komplexität in die technische Welt zu übersetzen, sind die täglichen Aufgaben.

Laut Khidr Suleman, Technical Writer, Service Design and Assurance beim UK Government Digital Service, sind die folgenden seine regelmäßigen täglichen Aufgaben:

• Teilnahme an Benutzerforschung
• Erstellung von Content-Strategien
• Präsentation von Plänen für hochrangige Interessengruppen
• Design und Prototyping von User Journeys
• Inhalte diskutieren, bearbeiten und (natürlich) schreiben

Ziemlich vielfältig.

Doch zu guter Letzt stand auf dieser Liste (natürlich) das zu tun, was sie wirklich tun.

Aber Schreiben (und insbesondere technisches Schreiben) ist eher ein Prozess als eine Aktivität.

Ein Staffellauf von Pflichten, die gemeinsam zur Übergabe der Dokumentation führen.

Kurz gesagt kann Technisches Schreiben beschrieben werden als der Prozess des „…Erfassens, Organisierens und Pflegens von Wissen über sich schnell ändernde Softwaresysteme“ – Atom Bank

Und so gehört der Umgang mit Repositories und Wissensdatenbanken zum Alltag eines Technischen Redakteurs.

Zum Beispiel Zitate oder Auszüge aus Expertenkommentaren aufnehmen. Sowie das Abrufen von goldenen Nuggets in Form von Fakten oder Daten, um Argumente zu validieren.

Kurz gesagt, die Einfachheit der Datenspeicherung, -suche und -lokalisierung oder -entdeckung – abgesehen vom Schreiben – sind auch wichtige verwandte Funktionen eines Hilfe-Autorenwerkzeugs.

Was ist ein Hilfe-Autorentool im Jahr 2022?

Wenn man den meisten Google-Definitionen auf Seite 1 für das Hilfe-Autorentool Glauben schenken will, sollte eine genaue Beschreibung Folgendes beinhalten:

1. Herstellung
2. Verwaltung
3. Veröffentlichung

…Unterlagen.

Die meisten behaupten, eine bessere Identität wäre „Content-Management-System“.

Zugegeben, dieser Begriff taucht tendenziell in Artikeln auf, die von CMS-Anbietern geschrieben wurden (und in dieser Hinsicht wäre dieser Artikel nicht anders), aber wenn wir die Genauigkeit der Verwendung untersuchen – ein CMS ist schließlich eine angemessene Bezeichnung für ein HAT.

Es unterstützt buchstäblich technische Redakteure beim Verfassen von Hilfedokumenten.

Was genau das angeht, was wir unter Hilfe verstehen – ich nehme an, es gibt keine festen Regeln dafür, wie weit man das nehmen könnte.

Es würde wirklich davon abhängen:

1. Wie gut kennen die Softwarehersteller die Disziplin der Technischen Redaktion und;
2. Wie überzeugt waren sie doch, den Bedarf zu decken

In den meisten Fällen konzentriert sich HAT darauf, die redaktionellen und redaktionellen Grundlagen richtig zu machen.

Und bieten Sie obendrein ein wenig Templating, Styling und Codierung an.

Aber die Frage ist…

… reichen diese Funktionen allein aus, um den hohen Anforderungen des modernen Technischen Redakteurs gerecht zu werden?

Warum fragen wir nicht einfach ein paar?…

1. In diesem Feedback-Auszug gibt der Befragte (ein technischer Redakteur) einen vergleichenden Überblick über eine herkömmliche HAT-Funktionalität im Vergleich zu einem herkömmlichen CMS (Drupal):

„Als Administrator in Drupal können Sie eine Liste von Seiten anzeigen, aber Sie können jeweils nur die Eigenschaften einer Seite bearbeiten. Es gibt keine Mehrfachauswahl und kein Drag-and-Drop . Themenmanagement kann also sehr mühsam sein.“

„Wenn Sie eine Seite löschen, werden alle Links, die darauf verweisen, unterbrochen , und es gibt keine Warnmeldungen.

Wenn Sie einen Link auf einer Seite erstellen , müssen Sie den Pfad und Namen der Zielseite kennen – es gibt keine hilfreichen Listen verfügbarer Seiten.“

„Out of the Box gibt es keinen WYSIWYG-Editor . Für die Mehrheit der HAT-Benutzer ist dies ein Muss. Sie können Ihre Inhalte nur in vollständigem/gefiltertem HTML schreiben.“

(Quelle: Kirschblatt)

2. In diesem Kommentar diskutierte ein anderer technischer Redakteur für Karriere zwei ideale Funktionen, von denen er glaubt, dass sie für die Zukunft der HAT-Software im Trend liegen würden:

„Faktenbasierte Suche: Wenn ein Benutzer auf die Registerkarte „Suchen“ klickt und nach einem Element sucht, kann der Benutzer die Suchergebnisse eingrenzen, indem er ähnliche Facetten verwendet, wie in der folgenden Abbildung gezeigt.“

„Wenn Sie eines der Standard-Authoring-Tools verwenden – Flare, RoboHelp, Author-It, Doc-to-Help – haben Sie das lächerliche Modell eines einzelnen Autors, der von einem einzigen Standpunkt aus von einer einzigen Organisation aus arbeitet und versucht, einen Ozean von Information. Da dieses Modell unhaltbar und nicht skalierbar ist, werden HATs zugunsten von kollaborativen webbasierten Autorentechnologien verschwinden .“

(Quelle: Ich würde lieber einen Blog schreiben)

Die oben gegebenen Erkenntnisse erweitern den Aufgabenbereich des traditionellen Sinnes eines HAT um eine dynamischere und kollaborativere Plattform zur Steigerung der Produktivität der technischen Redaktion.

Sollten Sie erwägen, ein Component Content Management System (CCMS) für die Hilfeerstellung zu verwenden?

Granularitätsgeschenksteuerung.

Und im Bereich der technischen Redaktion führt der Vorteil einer größeren Kontrolle innerhalb des Produktionszyklus zu Effizienzsteigerungen, die sich in einem höheren Projekt-ROI niederschlagen.

Genau hier kommt ein Komponenten-Content-Management-System ins Spiel.

Was ist ein Komponenten-Content-Management-System (CCMS)?

Ein Komponenten-Content-Management-System ist ein CMS, dessen Inhaltselemente keine Seiten und Beiträge sind, sondern Snippets, Absätze und Inhaltsteile.

So ähnlich würden Sie, wenn Sie einen neuen Inhalt in einem CMS erstellen, eine neue Seite oder einen neuen Beitrag beginnen.

Mit einem CCMS würden Sie eine neue Komponente (Teil einer Seite oder eines Beitrags) starten.

Viele Teile ergeben eine ganze Seite, sodass das Endergebnis ganzer Seiten und Posts dasselbe ist, aber die Art und Weise, wie sie erstellt werden, wird in kleine Teile aufgeteilt.

Wieso den?

Größenvorteile.

Sicher, es ist wohl mehr Arbeit, Seiten basierend auf mehreren Teilen (jedes mit eigenen Metadaten, Abhängigkeiten usw.) zu erstellen, als auf einem frei fließenden ganzen Teil.

Aber bei groß angelegten komplexen Content-Projekten mit vielen thematischen Überschneidungen und internen Referenzen ist die Wiederverwendbarkeit und granulare Austauschbarkeit auf Komponentenebene …

…ein CCMS bietet Autorenteams große langfristige Vorteile.

Nämlich, Dinge schneller und genauer zu erledigen.

Empfohlene Artikel mit Ratschlägen zum Hilfe-Autorentool

Die Wahl des am besten geeigneten Hilfe-Entwicklungstools ist mehr als nur ein Vergleich von „Funktionen und Vorteilen“.

Um das beste Ergebnis zu erzielen, müssen Sie sich intensiv mit der Benutzerfreundlichkeit befassen. Das Verständnis von Arbeitsabläufen und Aufgabenverwaltung hilft Ihnen, die Vor- und Nachteile der einzelnen Lösungen zu erkennen.

Um Sie bei einigen von Fachleuten empfohlenen Ratschlägen zu diesem Thema zu unterstützen, haben wir diese kurze Liste nützlicher HAT-bezogener Artikel zusammengestellt:

1. Warum Hüte verblassen
2. 5 Gründe, warum ich die Verwendung eines Cloud-basierten Autorentools empfehle
3. Was bringt Ihnen ein HAT gegenüber Drupal?
4. 6 Gründe für die Verwendung von HAT-Software
5. 5 Arten von Autorenwerkzeugen, die technische Redakteure verwenden

Die Autoren der obigen Artikel sprechen ziemlich sachkundig über das Thema HAT und geben einige Insider-Tipps, um die richtige Entscheidung zu treffen.

Was sind die Hauptmerkmale eines HAT?

So festigen wir allmählich unsere Sicht auf HATs, was sie tun und welche äußeren Vorteile wir neben dem traditionellen Ansatz berücksichtigen sollten.

Aber es wäre uns trotzdem wert, ein umfassendes Nachschlagewerk für all die Dinge zu haben, die ein HAT deos.

Auf diese Weise können wir „Äpfel für Äpfel“ vergleichen, wenn wir eine Anlageentscheidung in Betracht ziehen.

Hier ist eine Liste der gebräuchlichsten und umfassendsten HAT-Softwarefunktionen:

• Mehrere Eingabe- und Ausgabeformate : Importieren und exportieren Sie Daten mit vielen Dateitypen
• Voll ausgestattetes Textverarbeitungsprogramm : sowohl codebasierter als auch visueller WYSIWYG-Editor
• Tags erstellen : Weisen Sie thematische Tags zu, um Artikel thematisch in Beziehung zu setzen
• Themenvorlagen : Verschaffen Sie sich mit vorgefertigten Vorlagen einen Vorsprung bei jedem Teil  
• Syntax-Highlighter : hilfreiche Hervorhebungen zu grammatikalischen Problemen, die es zu lösen gilt  
• Merge-Tags für projektweite Metainformationen : Fügen Sie wiederverwendbare Snippets einfach mit Merge-Tags ein, spart Zeit und begrenzt Fehler
• Benutzerdefiniertes HTML, CSS, Javascript: Wenden Sie maßgeschneiderte Details auf Funktion und Design mit benutzerdefiniertem Webcode an
• Projektinhalte zusammenführen : Kombinieren von Inhalten innerhalb desselben Projekts, um ein gemischtes Ergebnis zu erzielen.  
• Anpassbares Webdesign : Schalter, Schieberegler und Kontrollkästchen zur Perfektionierung des Frontends des Tools, um Ihre Benutzererfahrung zu verbessern
• Media Repository : ein übersichtlicher Speicherbereich für all Ihre Bilder, PDFs, Audio- und Videodateien  
• Einfache Benutzeroberfläche : Einfach zu bedienen mit allen relevanten Bedienelementen in leicht erreichbarer Entfernung und Positionierung  
• Übersetzung : Lieferung in mehreren Sprachen
• Inhaltsverzeichnis : Einfach zu verwendende Sprunglinks in jedem Artikel zum Überfliegen des Inhalts  

Unter den dedizierten HATs da draußen decken die obigen Punkte den größten Teil dessen ab, was unter der Haube zu erwarten wäre.

Vorteile der Erstellung eines benutzerdefinierten HAT

Wenn ich den wichtigsten Vorteil des Baus eines benutzerdefinierten HAT zusammenfassen müsste, würde ich sagen:

Beherrschung Ihres eigenen Toolsets.

Maßgeschneidertes Werkzeugset

Wenn Sie als Profi haben, „was Sie wollen“, „wo und wie Sie es wollen“, ist die Kapitalrendite in Form von Zeitersparnis und verbesserten Ergebnissen unermesslich.

Sie können die Erfahrung mit Tools, die „genau richtig“ für den Erfolg gemacht wurden, einfach nicht mit einer Reihe generischer „Make Do“-Instrumente vergleichen.

Das Anpassen Ihres eigenen HATs kann also erhebliche Vorabarbeit und Aufregung erfordern.

Aber auf lange Sicht sind die Voraussetzungen dafür geschaffen, dass Sie mit jedem Projekt Ihre persönliche Bestleistung überbieten.

Erweiterbar

Mit einem benutzerdefinierten HAT müssen Sie nicht auf geplante Verbesserungen warten oder in Premium-Upgrades gezwängt werden.

Natürlich sind Sie für die Wartung und Verbesserung des Werkzeugs selbst verantwortlich, aber für ein wenig Heimwerkerzeit können Sie die Haltbarkeit Ihres HAT angemessen verlängern.

Kurz gesagt, je besser Ihr HAT wird, desto besser werden auch Ihre Ergebnisse.

Bessere Gesamtleistung

Ein maßgefertigter HAT beseitigt alle kleinen oder hinderlichen Ärgernisse aus Ihrem Arbeitsablauf für die technische Redaktion.

Sie beseitigen alle Engpässe und Zeitfresser und ersetzen sie durch Funktionen, Optionen und Konfigurationen, die Ihrem Rennen zum Abschluss von Projekten Rückenwind verleihen.

Sie werden leicht das übertreffen, was Sie bisher für möglich gehalten haben.

Erstellen eines WordPress-Hilfe-Autorentools mit dem Heroic Knowledge Base-Plugin

Also, wenn Sie jetzt bereit sind, neuen Gewässern zu trotzen und den Sprung in die Herstellung Ihres eigenen HATs zu wagen – wir haben genau die Lösung für Sie.

Einfach zu verwenden.

Aufgebaut auf einer Plattform, die von mehr als 40 % aller Websites online genutzt wird.

Mit den besten Funktionen – und mehr.

Hier ist es … unsere Kurzanleitung, wie man mit WordPress einen HAT erstellt.

Und das Beste daran ist, dass es überhaupt keinen Code gibt. Diese Methode ist sehr anfängerfreundlich.

Hier ist die Aufstellung:

1. Organisieren und Kategorisieren von Seiten und Dateien
2. Suche, Abstimmung, Feedback und Analysen
3. FAQ-Komponentenreplikation
4. Helpdesk zur Bearbeitung von Anfragen über Tickets
5. Seitenindex des Inhaltsverzeichnisses
6. Glossar Begriffsbibliothek

Ein kurzer Punkt zu „warum WordPress“.

Für die meisten Profis ist es das Wichtigste, die besten Werkzeuge für den Job zu haben (unabhängig davon, wie es genannt wird).

Semantik oder Namensnennung zählen nicht viel, da Sie von Ergebnissen durchdrungen sind und einen Motor mit etwas Drehmoment benötigen, um Sie auszugraben.

Hier ist WordPress ideal als Plattform für die Erstellung eines benutzerdefinierten HAT.

Erstens erfüllt es alle wesentlichen Kästchen in der Funktionsaufstellung, die zuvor in diesem Artikel erwähnt wurde. Und das mit Leichtigkeit, direkt aus der Box mit seinem Kernangebot.

Funktionen wie WYSIWYG und HTML, CSS und JS-Codierung sind Standardfunktionen, die von WordPress (dem weltweit führenden Content-Management-System) angeboten werden.

Aber WordPress beherbergt auch eine halbe Billion Dollar schwere Hosting-, Plugin- und Themenwirtschaft.

Diese Spieler sind verantwortlich für die Bereitstellung der erstklassigen Erweiterungen und Leistungsunterstützung, die das Tool zu einem maßgeschneiderten Zweck machen.

Alles in allem bilden WordPress und seine Plugin-Begleiter ein Dream-Team-Angebot eines HAT für jeden technischen Redakteur, der sein eigenes Setup erstellen möchte.

Hier ist eine Übersicht unserer empfohlenen Schritte zum Aufbau Ihres eigenen Online-Marktplatzes mit WordPress:

Verzeichnis-Homepage mit Silo-Kategorien: eine Hub-Seite, die als Index Ihrer Referenzbibliothek für abgeschlossene Projekte und recherchierte Ressourcen dient. Ein übersichtlicher Sammelplatz für den Zugriff auf Ihr technisches Schreibprotokoll.

Verwenden Sie das Heroic Knowledge Base-Plugin, um eine automatisch verknüpfte und aufgeschlüsselte Aufstellung Ihrer zuvor veröffentlichten HAT-Inhalte zu erstellen.

Suche, Abstimmung, Feedback und Analysen: In Anbetracht des Aufrufs zur Zusammenarbeit unserer beitragenden technischen Autoren von früher in diesem Artikel haben wir Dynamik und Engagement in die Funktionen unserer WordPress HAT-Lösung integriert. Die Bereitstellung von Suche, Feedback und Einblicken wird nur dazu beitragen, größere Verbesserungen zu entwickeln.

Verwenden Sie das Heroic Knowledge Base-Plug-in, um Benutzerforschungsverbesserungen zu ermöglichen, um eine iterative Verbesserungs-Roadmap für das Produkt zu leiten.

FAQ-Komponentenreplikation : Konfigurieren Sie die granulare Komponentensteuerung für häufig gestellte Fragen, um sich den Vorteil einer schlankeren Produktion für die Skalierung größerer Projekte zu verschaffen.

Verwenden Sie das Heroic FAQs-Plugin, um Ihren HAT mit integrierten wiederverwendbaren Komponenten mit einfacher Installation und Serocode auszustatten.

Heroic Inbox für die Bearbeitung von Anfragen über Tickets: um Benutzer-Support-Tickets bequem zu beantworten und Ihnen einen reaktionsschnellen E-Mail-Hilfekanal zu bieten, der sich in Ihrer WordPress-Installation befindet.

Verwenden Sie das Heroic Inbox-Plugin, um Ihren geschäftlichen E-Mail-Posteingang in Ihr WordPress-Admin-Dashboard zu integrieren. Dadurch erhalten Sie einen einheitlichen Kommunikations-Hub innerhalb Ihres HAT, wodurch Sie Zeit sparen, die Sie ansonsten mit der Navigation durch einen unzusammenhängenden Workflow verbringen würden.

Heroisches Inhaltsverzeichnis: Jumplinks zum leichteren Überfliegen Ihrer Artikel helfen den Lesern, Informationen zu verdauen und Werte zu extrahieren. Machen Sie Ihre Stücke mit einem klassischen Inhaltsverzeichnis noch konsumierbarer.

Verwenden Sie das heroische Inhaltsverzeichnis, um jedem Ihrer Artikel ein Inhaltsverzeichnis hinzuzufügen, das automatisch ausgefüllt wird.

Heroisches Glossar: Erstellen Sie eine AZ-Liste mit nützlichen Begriffen als Abkürzung für den Zugriff auf Definitionen von Schlüsselwörtern in einem Projekt, damit Sie beim Schreiben Ihres neuen Projekts agil bleiben.

Verwenden Sie das Heroic Glossary-Plugin, um ein durchsuchbares Glossar in Ihrem WordPress-HAT zu installieren – kein Problem und (wieder) kein Code.

Aspose.Words: Konvertieren Sie WordPress-Beiträge oder -Seiten sofort in DOC- oder DOCX-Dateien und umgekehrt. Überbrücken Sie Workflow-Lücken und machen Sie Ihr neues System mit älteren GDocs- oder Word-Dokumenten-Assets kompatibel.

Verwenden Sie das Aspose.Words-Plugin, um die bidirektionale Dateikonvertierung zwischen WordPress und GDocs oder Word zu ermöglichen.

Syntax Highlighter Evolved: Heben Sie den Webcode hervor, wenn Sie benutzerdefinierte Änderungen vornehmen, und helfen Sie dabei, sich ohne Ablenkung auf die Details zu konzentrieren.

Verwenden Sie Syntax Highlighter Evolved , um Code schön zu gestalten, während Sie Ihre Web-versierten Änderungen vornehmen.

Fazit

Zweckgefertigte HATs in diesen Tagen solch fortschrittlicher CMS erfinden wahrscheinlich das Rad neu.

Es gibt tatsächlich nicht viel (wenn überhaupt), was selbst das am weitesten fortgeschrittene HAT kann, was ein CMS mit einer gewissen Konfiguration nicht tun könnte.

Außerdem verfügen Sie mit einem CMS über zusätzliche Funktionen, die einem bereits wettbewerbsfähigen Angebot einen Vorteil verleihen.

Das weitere Potenzial, das ein CMS (das marktführende WordPress mit seinen Plugins) bietet, kann eine vergleichbare HAT-Lösung über Ihre Erwartungen hinaus erweitern.

Viel Platz, um Ihren eigenen Juckreiz zu beseitigen und mit WordPress weiter innovativ zu sein – plus keine Codierung erforderlich.

Ein schnell wachsendes Plugin-Ökosystem von Drittanbietern unterstützt den Marktanteilsvorteil von WordPress mit spezialisierten Produkten, um die Grenzen des Möglichen zu verschieben.

Alles in allem sind wir davon überzeugt, dass WordPress CMS die ideale digitale Plattform ist, wenn Sie eine zukunftssichere, benutzerdefinierte HAT-Investition tätigen möchten.

Warum nicht heute anfangen?