Hilfe-Entwicklungstools

Die Erstellung von Hilfedokumentationen für Produkte hat viele Ähnlichkeiten mit einer typischen studentischen Projektarbeit. Eine studentische Projektarbeit muss oft:

• Ein Thema in der Tiefe diskutieren und jeden Aspekt des Themas gründlich behandeln
• Ein Thema in deutlich identifizierbare Abschnitte unterteilen
• Detaillierte Verweise einfügen, die das Fazit der Projektarbeit unterstützen
• Ein das diskutierte Thema vollständig abdeckendes Inhaltsverzeichnis erstellen

Eine Hilfe-Entwicklungssoftware ist zur Handhabung all dieser Aufgaben viel besser geeignet als ein konventionelles Textverarbeitungsprogramm. Wenn Sie eine studentische Projektarbeit in Microsoft Word schreiben, bleibt Ihnen kaum etwas anderes übrig, als am Anfang des Themas anzufangen und das ganze Ding der Länge nach einzutippen. Dieser Ansatz macht das Schreiben von Projektarbeiten knifflig und äußerst zeitaufwendig.

Das Verfassen von Hilfedokumentationen bedeutet harte Arbeit; ein technischer Redakteur muss jede Funktion eines Produkts auf verständliche Weise beschreiben. Die Dokumentation muss für eine große Bandbreite an Produktanwendern mit unterschiedlich ausgeprägter technischer Fachkenntnis oder verschiedenen Erwartungen geschrieben werden.
Trotz dieser Voraussetzung finden viele technische Redakteure, dass das Schreiben der Hilfedokumentation der einfache Teil des Prozesses ist. Nachdem sie alles aufgeschrieben haben, was notwendig ist, um das Thema ordentlich abzudecken, müssen sie die Dokumentation so formatieren, dass sie in einer Vielzahl an Formaten zugänglich und einfach lesbar ist. Eventuell erforderliche Formate umfassen PDF, Word, Online-HTML, vielleicht HLP oder auch CHM. Der ganze Formatierungsprozess kann sehr zeitaufwendig sein, vor allem da die meisten technischen Redakteure sich darauf konzentrieren wollen, wirklich gute Hilfedokumentationen zu schreiben, anstatt sich ewig darum zu kümmern, wie ihre Seiten auf verschiedenen Geräten angezeigt werden.
Wenn die Dokumentation schließlich fertig ist, bedeutet das häufig noch immer nicht das Ende des Prozesses, denn jedes Mal, wenn das Produkt abgeändert wird, muss die Dokumentation revidiert werden, um die neuen oder aktualisierten Funktionen widerzuspiegeln.