Hilfe erstellen mit Software-Tools

Was ist eine Hilfe-Erstellung?

Redaktionelle Hilfen werden oft von technischen Mitarbeitern im Rahmen von Dokumentationen, Anweisungen oder Anleitungen erstellt. Dabei kann es sich um Anleitungen zu technischen Geräten handeln oder um eine Software-Hilfe. Das Resultat der Arbeit der jeweiligen Fachperson ist dann oft ein Handbuch für eine Betriebsanweisung, eine Hilfe-Datei (*.chm) für eine Software oder eine pdf-Datei, welche über passende Kanäle publiziert werden.

Verwendung von Hilfen als Datei oder Handbuch

Es gibt viele denkbare Einsatzfälle um eine Hilfe zu erstellen. Hier mal ein paar aus dem (Arbeits-)Leben gegriffene Beispiele:

  • eine Firma, die Ihre Arbeitsprozesse und/oder QS-Management beschreiben und zugänglich machen möchte, vielleicht sogar für eine ISO9001-Zertifizierung
  • eine Bedienungsanleitung für ein Produkt erzeugen und veröffentlichen
  • in einem Softwareprogramm eine Hilfe bereitstellen
  • eine firmeninterne Dokumentation zu Herstellungsverfahren, Produktionsanleitungen, die dann im firmeninternen Dokumentenmanagementsystem verwaltet wird
  • Veröffentlichungen von strukturierten Inhalten im Internet, z.B. von Seminaren oder Vorlesungsreihen
  • der einzelne Mitarbeiter, der sich eine kleine eigene Wissensdatenbank zusammenschreibt und diese vielleicht im Intranet der Firma veröffentlichen möchte

Eigenschaften einer guten Hilfe

Eine gute Hilfe-Erstellung, wie der DA-HelpCreator, sollte folgende Eigenschaften haben, damit es für den Leser keine quälende Tortour, wie bei einer IKEA-Anleitung, wird:
Exportformate des DA-HelpCreators

  • gute Strukturierungsmöglichkeiten zum Beispiel über automatische Inhaltsverzeichnisse mit verschiedenen Ebenen
  • kurze, knappe, eindeutige Beschreibungen
  • sehr gute Bebilderung (Ein Bild sagt mehr als tausend Worte)
  • Unterstützung viele Export-Formate, wie HTML, PDF oder CHM
  • guten Handling, schnelle Einfügen von Grafiken, Textpassagen
  • gute Verlinkung und Verweisstruktur

Dies alles händisch mit einem Texteditor, wie Word, zu erstellen, ist erstens recht mühsam und zweitens noch nicht das Ende der Fahnenstange. Denn den normalen Texteditoren, fehlen praktische Möglichkeiten zum Export. Oder schnelles Schreiben durch Verwendung von Markup-Sprachen, wie Markdown. Oder die Möglichkeit das Design eines Projekts vom Inhalt zu entkoppeln. Dadurch lassen sich Dokumente und Dokumentenstände auch gut verwalten, zum Beispiel in einem SVN.

Screenshot Hilfe erstellen mit DA-HelpCreator

Kommentar hinterlassen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.