Jede Software benötigt eine Produktdokumentation. Aber nur wenn sie cool ist, wird sie auch benutzt.
Eine Softwaredokumentation ist cool, wenn die Anwender sie auf unterschiedlichen Medien abrufen können. Häufig verlangt werden etwa:
- PDF zum Ausdrucken,
- CHM-Datei (Microsoft-HTML-Hilfe) für den lokalen Zugriff,
- WebHelp-Format für den stationären Zugriff über das Internet,
- Responsive HTML für den mobilen Zugriff über das Internet,
- Schrittanleitungen in kleinen How-to-Videos.
Mit dem richtigen Workflow lassen sich diese unterschiedlichen Ausgabeformate weitgehend aus einer Quelle erstellen.
- Erstellen der Dokumentation in Microsoft Word auf der Basis einer geeigneten Dokumentvorlage.
- PDF aus Word heraus erstellen.
- Die Word-Dokumente in Adobe RoboHelp importieren.
- Aus RoboHelp heraus lassen sich unter anderem die Formate CHM, WebHelp und Responsive HTML5 erstellen.
- Schrittanleitungen bilden die Drehbücher für How-to-Videos. Diese lassen sich beispielsweise mit Adobe Captivate erstellen. Captivate kann Ausgaben in HTML5 oder MP4 erzeugen. Links zu den Videos lassen sich als URL oder QR-Code in die anderen Dokumente einbetten.
Als kleines Beispiel für diesen Workflow habe ich auf diese Weise ein Mini-Handbuch erstellt: Mit Word-Makros arbeiten. Die Dokumentation ist hier verfügbar als:
- PDF-Datei
- WebHelp
- Responsive HTML5
- Die Schrittfolge „Ein Word-Makro aufzeichnen“ als
How-to-Video im HTML5-Format und als Youtube-Video
Das Erstellen einer solchen coolen Produktdokumentation in mehreren Ausgabeformaten muss keinen Riesenaufwand erfordern.
Und cool muss sie sein. Denn sonst werden Ihre Anwender sie nicht nutzen wollen.