Wie man mit WordPress ein Hilfe-Autorentool erstellt

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

Das Arbeitspferd des technischen Schreibens - ein Tool zur Erstellung von Hilfetexten - nimmt den Stress und macht die Kunst, komplexe Dinge verständlich zu machen, zu einem 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, damit sie perfekt für den Zweck geeignet sind...

...brauchen Sie wirklich einen HAT, der Ihnen zur Seite steht und Ihnen hilft, alle Ihre Bemühungen auf die Formulierung des besten literarischen Produkts zu konzentrieren.

Das Konzept eines HAT ist nicht neu.

Es gibt sie schon lange.

Und manch einer würde sagen, wenn es sich um ein Familienfoto handeln würde, wären sie vielleicht schon leicht mit Eselsohren versehen, sepiafarben und sogar in ihrer Bedeutung verblasst.

Zum Beispiel wird in vielen Fällen ein WYSIWYG-Editor als Premium-Funktion angesehen.

Aber wenn man etwas weiter denkt, könnte man die Vielseitigkeit und die vielfältigen übertragbaren Vorteile eines Content-Management-Systems (CMS) nutzen, um HATs ins 21. Jahrhundert zu katapultieren?

Im Fall von WordPress CMS - der weltweit führenden Plattform für die Erstellung von Webseiten und der mit Abstand beliebtesten CMS-Software - würden wir sagen, dass...

...lautet die Antwort: JA.

Aber nehmen Sie uns nicht einfach beim Wort, sondern nehmen Sie sich die nächsten Minuten Zeit, um ein wenig tiefer in die Frage einzutauchen, warum WordPress CMS das Beste ist, was technischen Redakteuren passieren kann, denn geschnittenes Brot Espresso-Kaffee.

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

Die typischen Anforderungen an einen Technischen Redakteur von heute

Die technische Redaktion umfasst heute viele Fachgebiete.

• Öffentliche Politik der Regierung
• I.T.-Verarbeitung
• Finanzielle Investitionen
• Immobilien

...die Liste geht weiter.

Allen gemeinsam sind jedoch die hohen Anforderungen, die sich aus der Übersetzung komplexer Sachverhalte in die technische Welt ergeben, sowie die täglichen Aufgaben.

Nach Angaben von Khidr Suleman, Technical Writer, Service Design and Assurance beim UK Government Digital Service, gehören die folgenden Aufgaben zu seinem Alltag:

• Teilnahme an der Nutzerforschung
• Erstellung von Inhaltsstrategien
• Präsentation der Pläne vor hochrangigen Interessengruppen
• Entwurf und Prototyping von User Journeys
• Erörterung, Bearbeitung und (natürlich) Verfassen von Inhalten

Ziemlich vielfältig.

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

Aber das Schreiben (und insbesondere das technische Schreiben) ist eher ein Prozess als eine Tätigkeit.

Ein Staffellauf von Aufgaben, die gemeinsam zur Lieferung von Unterlagen führen.

Kurz gesagt, kann man das technische Schreiben als den Prozess der "...Erfassung, Organisation und Pflege von Wissen über sich schnell verändernde Softwaresysteme" beschreiben - Atom Bank

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

Aufzeichnung von Zitaten oder Auszügen aus Expertenkommentaren, zum Beispiel. Und das Aufspüren von "goldenen Nuggets" in Form von Fakten oder Daten zur Untermauerung von Argumenten.

Kurz gesagt, einfache Datenspeicherung, Suche und Auffinden von Daten sind - neben dem Schreiben - ebenfalls wichtige Funktionen eines Hilfeerstellungswerkzeugs.

Was ist ein Help-Authoring-Tool im Jahr 2024?

Wenn man den meisten Google-Definitionen auf Seite 1 für Hilfe-Authoring-Tool Glauben schenken kann, sollte eine genaue Beschreibung Folgendes enthalten:

1. Herstellung
2. Verwaltung von
3. Veröffentlichung

...Dokumente.

Die meisten behaupten, eine bessere Bezeichnung wäre "Content-Management-System".

Zugegeben, dieser Begriff wird in der Regel in Artikeln von CMS-Anbietern verwendet (und in dieser Hinsicht wäre dieser Artikel nicht anders), aber wenn wir uns die Verwendung der Genauigkeit ansehen - ein CMS ist schließlich eine angemessene Bezeichnung für einen HAT.

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

Was die genaue Bestimmung dessen angeht, was wir unter Hilfe verstehen, so gibt es wohl keine festen Regeln, wie weit man das fassen kann.

Das würde wirklich davon abhängen:

1. Wie gut kennen die Softwarehersteller die Disziplin des technischen Schreibens, und;
2. Wie überzeugt sie waren, den Bedarf zu decken

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

Und ein wenig Templating, Styling und Coding obendrauf bieten.

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) eine vergleichende Bewertung einer traditionellen HAT-Funktionalität gegenüber einem traditionellen CMS (Drupal) ab:

"Als Administrator in Drupal können Sie eine Liste von Seiten anzeigen, aber Sie können immer nur die Eigenschaften einer Seite auf einmal bearbeiten. Es gibt keine Mehrfachauswahl und kein Drag-and-Drop. Die Themenverwaltung kann also sehr mühsam sein."

"Wenn Sie eine Seite löschen, werden alle Links, die auf sie verweisen, zerstörtund es gibt keine Meldungen, die Sie warnen.

Wenn Sie einen Link in einer Seite erstellen müssen Sie den Pfad und den Namen der Zielseite kennen - Es gibt keine hilfreichen Listen der verfügbaren Seiten."

"Standardmäßig 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: Cherry Leaf)

2. In diesem Kommentar erörterte ein anderer technischer Redakteur zwei ideale Funktionen, die seiner Meinung nach für die Zukunft der HAT-Software geeignet wären:

"Faktensuche": Wenn ein Benutzer auf die Registerkarte "Suche" klickt und nach einem Element sucht, kann er die kann der Benutzer die Suchergebnisse einschränken einschränken, indem er ähnliche Facetten verwendet, wie in der folgenden Abbildung gezeigt."

"Die Verwendung von Standard-Authoring-Tools - Flare, RoboHelp, Author-It, Doc-to-Help - führt zu dem lächerlichen Modell eines einzelnen Autors, der von einem einzigen Standpunkt aus in einer einzigen Organisation arbeitet und versucht, einen Ozean von Informationen zusammenzustellen. Denn dieses Modell ist unhaltbar und nicht skalierbar, werden HATs zugunsten von kollaborativen, webbasierten Autorentechnologien verschwinden."

(Quelle: I'd Rather Be Writing Blog)

Die oben dargelegten Erkenntnisse erweitern den Aufgabenbereich des traditionellen HAT um eine dynamischere und kollaborative Plattform zur Steigerung der Produktivität beim technischen Schreiben.

Sollten Sie den Einsatz eines Component Content Management Systems (CCMS) für die Hilfeerstellung in Betracht ziehen?

Granularitätsgeschenke Kontrolle.

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 ROI des Projekts niederschlagen.

Genau an dieser Stelle kommt ein Content-Management-System ins Spiel.

Was ist ein Component Content Management System (CCMS)?

Ein Component Content Management System ist ein CMS, dessen Inhalte nicht aus Seiten und Beiträgen bestehen, sondern aus Snippets, Absätzen und Inhaltsteilen.

Wenn Sie also einen neuen Inhalt in einem CMS erstellen wollen, beginnen Sie eine neue Seite oder einen neuen Beitrag.

Mit einem CCMS beginnen Sie eine neue Komponente (Teil einer Seite oder eines Beitrags).

Viele Teile machen eine ganze Seite aus, so dass das Endergebnis von ganzen Seiten und Beiträgen dasselbe ist, aber die Art und Weise, wie sie erstellt werden, ist in kleine Teile aufgeteilt.

Warum?

Größenvorteile.

Sicherlich ist es aufwändiger, Seiten aus mehreren Teilen (mit jeweils eigenen Metadaten, Abhängigkeiten usw.) zu erstellen als aus einem einzigen, frei fließenden Ganzen.

Aber bei großen, komplexen Inhaltsprojekten mit vielen thematischen Überschneidungen und internen Verweisen ist die Wiederverwendbarkeit und granulare Austauschbarkeit auf Komponentenebene...

...ein CCMS bietet den Autorenteams langfristig große Vorteile.

Nämlich die Dinge schneller und genauer zu erledigen.

Empfohlene Beratungsartikel für das Help Authoring Tool

Die Wahl des am besten geeigneten Tools für die Erstellung von Hilfe ist mehr als nur ein Vergleich von Funktionen und Vorteilen".

Um das beste Ergebnis zu erzielen, müssen Sie sich intensiv mit der Benutzerfreundlichkeit auseinandersetzen. Wenn Sie die Arbeitsabläufe und die Aufgabenverwaltung verstehen, können Sie die Vor- und Nachteile der einzelnen Lösungen besser einschätzen.

Um Ihnen einige empfehlenswerte Ratschläge zu diesem Thema an die Hand zu geben, haben wir diese kurze Liste mit nützlichen Artikeln zum Thema HAT zusammengestellt:

1. Warum HATs verblassen werden
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 den Einsatz von HAT-Software

Die Autoren der oben genannten Artikel sprechen ziemlich sachkundig über das Thema HAT und geben eine Reihe von Insider-Tipps, um die richtige Entscheidung zu treffen.

Was sind die wichtigsten Merkmale eines HAT?

Wir festigen also allmählich unsere Meinung über HATs, was sie leisten und welche Vorteile wir neben dem traditionellen Ansatz in Betracht ziehen sollten.

Aber es wäre trotzdem gut, wenn wir eine umfassende Referenz für all die Dinge hätten, die ein HAT tut.

Auf diese Weise können wir Äpfel mit Äpfeln" vergleichen, wenn wir eine Investitionsentscheidung treffen.

Im Folgenden finden Sie eine Liste der häufigsten und umfassendsten Funktionen der HAT-Software:

• Mehrere Eingabe- und Ausgabeformate: Importieren und Exportieren von Daten mit vielen Dateitypen
• Voll funktionsfähiges Textverarbeitungsprogramm: sowohl codebasierter als auch visueller WYSIWYG-Editor
• Erstellen von Tags: Vergeben Sie thematische Tags, um Artikel thematisch zu verknüpfen.
• Themenvorlagen: Mit vorgefertigten Vorlagen haben Sie bei jedem Stück einen Vorsprung
• Syntax-Highlighter: hilfreiche Hervorhebungen grammatikalischer Probleme, die gelöst werden müssen
• Merge-Tags für projektweite Meta-Informationen: Wiederverwendbare Snippets lassen sich mit Hilfe von Merge-Tags leicht einfügen, was Zeit spart und Fehler einschränkt
• Benutzerdefiniertes HTML, CSS, Javascript: Funktion und Design mit benutzerdefiniertem Webcode auf den Punkt bringen
• Zusammenführung von Projektinhalten: Kombination von Inhalten innerhalb desselben Projekts, um ein gemischtes Ergebnis zu erzielen.
• Anpassbares Webthema: Schalter, Schieberegler und Kontrollkästchen zur Perfektionierung des Frontends des Tools, um die Benutzererfahrung zu verbessern
• Medienablage: ein übersichtlicher Speicherbereich für alle Ihre Bilder, PDFs, Audio- und Videodateien
• Einfache Benutzeroberfläche: einfache Bedienung mit allen relevanten Bedienelementen in leicht erreichbarer Entfernung und Position
• Übersetzung: Lieferung in mehreren Sprachen
• Inhaltsverzeichnis: einfach zu verwendende Sprunglinks in jedem Artikel, um den Inhalt zu überfliegen

Die oben genannten Punkte decken den größten Teil dessen ab, was unter der Haube von HATs erwartet werden kann.

Vorteile des Baus eines individuellen HATs

Wenn ich den Hauptvorteil des Baus eines maßgeschneiderten HATs zusammenfassen müsste, würde ich sagen:

Beherrschung des eigenen Instrumentariums.

Maßgeschneiderter Werkzeugsatz

Wenn Sie als Fachmann haben, was Sie wollen, wo und wie Sie es wollen, ist die Rendite in Form von Zeitersparnis und besseren Ergebnissen unermesslich.

Man kann die Erfahrung der Verwendung von Werkzeugen, die "genau richtig" für den Erfolg gemacht wurden, einfach nicht mit einem Satz allgemeiner "Behelfsinstrumente" vergleichen.

Die Herstellung eines eigenen Hutes kann also mit viel Arbeit und Aufwand verbunden sein.

Aber auf lange Sicht sind die Weichen dafür gestellt, dass Sie bei jedem Projekt Ihre persönliche Bestleistung übertreffen.

Ausbaufähig

Das Warten auf geplante Verbesserungen oder der Zwang, Premium-Upgrades zu erwerben, muss bei einem Custom HAT nicht sein.

Natürlich müssen Sie das Gerät selbst warten und verbessern, aber mit ein wenig Zeitaufwand können Sie die Lebensdauer Ihres HAT angemessen verlängern.

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

Bessere Allround-Leistung

Ein maßgeschneiderter HAT beseitigt alle unbedeutenden oder hinderlichen Ärgernisse in Ihrem Arbeitsablauf der technischen Redaktion.

Sie beseitigen alle Engpässe und Zeitfresser und ersetzen sie durch Funktionen, Optionen und Konfigurationen, die Ihrem Wettlauf um den Abschluss von Projekten neuen Schwung verleihen.

Sie werden mit Leichtigkeit erreichen, was Sie bisher für möglich hielten.

Erstellung eines WordPress-Hilfetools mit dem Heroic Knowledge Base Plugin

Wenn Sie also bereit sind, sich in neue Gewässer zu wagen und den Schritt zu wagen, Ihren eigenen Hut zu machen, dann haben wir genau die richtige Lösung für Sie.

Einfach zu bedienen.

Basierend auf einer Plattform, die von mehr als 40 % aller Websites im Internet genutzt wird.

Mit all den besten Funktionen - und noch mehr.

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

Und das Beste daran ist, dass kein einziger Code erforderlich ist. 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-Software für die Bearbeitung von Anfragen über Tickets
5. Inhaltsverzeichnis Seitenindex
6. Glossar Begriff Bibliothek

Ein kurzer Hinweis zum Thema "Warum WordPress".

Für die meisten Fachleute ist es das Wichtigste, die besten Werkzeuge für ihre Arbeit zu haben (unabhängig davon, wie sie genannt werden).

Semantik oder Beschimpfungen zählen nicht viel, wenn man sich in Leistungen verstrickt und einen Motor mit einem gewissen Drehmoment braucht, um wieder herauszukommen.

Hier ist WordPress die ideale Plattform für die Erstellung eines individuellen HAT.

Erstens erfüllt es alle wichtigen Funktionen, die bereits in diesem Artikel erwähnt wurden. Und das tut es mit Leichtigkeit, direkt nach dem Auspacken mit seinem Kernangebot.

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

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

Diese Akteure sind für die Bereitstellung der erstklassigen Erweiterungen und der Leistungsunterstützung verantwortlich, die das Tool zu einer maßgeschneiderten Lösung für den jeweiligen Zweck machen.

Alles in allem sind WordPress und seine Plugin-Begleiter ein Traumteam, das einen HAT für jeden technischen Redakteur anbietet, der sich sein eigenes System zusammenstellen möchte.

Hier finden Sie einen Überblick über die von uns empfohlenen Schritte zum Aufbau Ihres eigenen Online-Marktplatzes mit WordPress:

Verzeichnis-Homepage mit unterteilten Kategorien: eine Hauptseite, die als Index Ihrer Referenzbibliothek für abgeschlossene Projekte und recherchierte Ressourcen dient. Eine übersichtliche Sammelstelle für den Zugriff auf Ihr technisches Schreibprotokoll.

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

Heroic Inbox für die Bearbeitung von Anfragen über Tickets: zur bequemen Bearbeitung von Benutzer-Support-Tickets, die Ihnen einen reaktionsschnellen E-Mail-Hilfekanal innerhalb Ihrer WordPress-Installation bieten.

Verwenden Sie das PluginHeroic Inbox , um Ihren geschäftlichen E-Mail-Eingang in Ihr WordPress-Administrations-Dashboard zu integrieren. So erhalten Sie eine einheitliche Kommunikationszentrale in Ihrem HAT und sparen Zeit, die Sie sonst für die Navigation in einem unzusammenhängenden Arbeitsablauf aufwenden müssten.

Heroic Table of Contents: Jumplinks, die das Überfliegen Ihrer Artikel erleichtern, helfen den Lesern, die Informationen zu verdauen und einen Mehrwert zu erhalten. Machen Sie Ihre Artikel mit einem klassischen ToC noch konsumierbarer.

Verwenden Sie die Heroic Table of Contents um jedem Ihrer Artikel ein sich automatisch ausfüllendes Inhaltsverzeichnis hinzuzufügen.

Heroic Glossary: eine A-Z-Liste mit nützlichen Begriffen als Abkürzung für den Zugriff auf Definitionen von Schlüsselwörtern zu einem Projekt zusammenstellen, damit Sie beim Schreiben Ihres neuen Projekts agil bleiben.

Verwenden Sie das PluginHeroic Glossary , um ein durchsuchbares Glossar in Ihrem WordPress HAT zu installieren - ganz ohne Aufwand und (wieder) ohne Code.

Wenn Sie mehr über das Glossar erfahren möchten, lesen Sie unseren Leitfaden zur Erstellung eines Glossars mit WordPress.

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

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

Syntax Highlighter Evolved: Hebt den Webcode bei der Bearbeitung hervor und hilft Ihnen, sich ohne Ablenkung auf die Details zu konzentrieren.

Verwenden Sie Syntax Highlighter Evolved, um Ihren Code bei der Bearbeitung von Webinhalten zu verschönern.

Schlussfolgerung

Speziell angefertigte HATs sind in der heutigen Zeit, in der es so fortschrittliche CMS gibt, wahrscheinlich eine Neuerfindung des Rades.

Es gibt eigentlich nicht viel (wenn überhaupt etwas), was selbst der am besten ausgestattete HAT tun kann, was ein CMS mit etwas Konfiguration nicht tun könnte.

Außerdem haben Sie mit einem CMS zusätzliche Funktionen, die ein bereits wettbewerbsfähiges Angebot noch besser machen.

Die weiteren Möglichkeiten, die ein CMS (das marktführende WordPress mit seinen Plugins) bietet, können eine vergleichbare HAT-Lösung über das hinaus erweitern, was Sie erwarten.

Viel Raum für eigene Ideen und weitere Innovationen mit WordPress - und das ganz ohne Programmierkenntnisse.

Ein schnell wachsendes Plugin-Ökosystem von Drittanbietern unterstützt den Marktanteilsvorteil von WordPress mit spezialisierten Produkten, die die Grenzen der Möglichkeiten erweitern.

Alles in allem sind wir davon überzeugt, dass WordPress CMS die ideale digitale Plattform ist, wenn Sie eine zukunftssichere, individuelle HAT-Investition tätigen möchten. Warum nicht gleich heute damit anfangen?