Wie kann die Dokumentation optimiert werden? Welches Format passt am besten? Wir beraten zu allen Fragen rund um die Dokumentation.
Welche Dokumente werden benötigt?
Dokumentation soll Benutzer dabei unterstützen, sich mit der Software vertraut zu machen und sie effizient zu verwenden. Im Idealfall orientiert sich die Dokumentation an den Zielen der Benutzer und hilft ihnen, ihre Aufgaben zu erledigen.
Wir helfen Ihnen bei der Beantwortung der Frage, welche Dokumente für Ihr Softwareprodukt benötigt werden. Dazu führen wir eine Aufgaben- und Zielgruppenanalyse durch und bestimmen auf dieser Grundlage, wie die optimale Informationsarchitektur aussieht.
Wie die bestehende Dokumentation optimieren?
Bei Produkten, die länger am Markt sind, ist die Produktdokumentation über Jahre oft auf einen beträchtlichen Umfang gewachsen. Die Dokumentation wurde zwar soweit möglich immer wieder aktualisiert und ergänzt, jedoch nie grundlegend neu strukturiert und sich ändernden Anforderungen angepasst.
Gewachsene Dokumentation wird im Lauf der Zeit unübersichtlich. Aufgrund des großen Umfangs werden Informationen oft mehrfach hinzugefügt, zum Teil in unterschiedlichen Varianten. Benutzer finden oft die gewünschten Informationen nicht mehr oder sind verunsichert durch sich widersprechende Informationen. Die Dokumentation beantwortet nicht mehr die Fragen der Benutzer, Support-Anfragen häufen sich.
Eine sinnvolle Pflege und Aktualisierung der Dokumentation wird aufgrund der Menge und der gewachsenen Strukturen immer mehr zur Herausforderung.
Hinzu kommt oft das Problem, dass die Möglichkeiten des verwendeten Redaktionswerkzeugs, meist ein klassisches Textverarbeitungstool, nicht mehr ausreichen. Es fehlen Content Management-Funktionen, die eine effiziente Aktualisierung und Strukturierung ermöglichen. Neue Formate, beispielsweise eine Online-Dokumentation, können nicht oder nur mit großem Nachbearbeitungsaufwand erzeugt werden.
Das bisherige Verfahren ist an seine Grenzen gestoßen und nicht zukunftsfähig. Doch wie eine Verbesserung am besten angehen? Wie kann die Dokumentation besser strukturiert werden? Und mit welchem Tool lässt sich die zukünftige Lösung am besten umsetzen?
Wir unterstützen Sie bei der Neugestaltung und Optimierung Ihrer bestehenden Dokumentation. Wir analysieren den Bestand, erarbeiten mit Ihnen die Ziele der Optimierung, planen die schrittweise Umsetzung und helfen bei der Umstellung.
Welches Format ist geeignet?
Softwaredokumentation gibt es in vielen Formaten, beispielsweise als Online-Dokumentation oder Video-Tutorial im Web, als Online-Hilfe in der Anwendung, als Handbuch im PDF-Format oder gedruckt auf Papier.
Wir beraten Sie zum optimalen Format für Ihre Dokumentation. Dabei berücksichtigen wir, welches Format am besten zu Ihren Software-Produkten, zu den Anwendern und zu Ihren Auslieferungsprozessen passt.
Ist ein Single-Source-Ansatz realisierbar?
Bei einem Single-Source-Ansatz werden mehrere Dokumente aus „einer Quelle“ (engl. single source) generiert, beispielsweise:
- Handbuch und Online-Hilfe
- Handbuch und Schulungsunterlage
- Online-Hilfen zu Produktvarianten
- kundenspezifische Handbücher
Als Quelle dient ein einzelnes Dokument oder eine Sammlung von Themen, die zu Dokumenten kombiniert werden können. Redaktionswerkzeuge unterstützen Single-Sourcing durch Spezialfunktionen wie bedingter Text, Variablen, Textbausteine und Generierung verschiedener Ausgabeformate.
Eine Single-Source-Lösung hat den Vorteil, dass nur eine Quelle gepflegt werden muss. Redundanzen und Inkonsistenzen können dadurch vermieden werden. Pflegeaufwand und Übersetzungskosten können ebenso vermindert werden.
Bei einem Umstieg auf Single-Sourcing sind jedoch viele Herausforderungen zu meistern. Es muss geklärt werden, welche Single-Source-Methodik am besten passt und mit welchem Werkzeug am besten umgesetzt werden kann. Der Text muss in wiederverwendbare Einheiten aufgeteilt werden und wiederverwendbar geschrieben sein.
Wir unterstützen Sie bei der Einführung einer Single-Source-Lösung. Wir analysieren Ihre bestehende Dokumentation und prüfen, ob und wie ein Single-Source-Ansatz machbar ist. Nach der Auswahl des richtigen Werkzeugs unterstützen wir Sie bei der Neustrukturierung Ihrer Dokumente, so dass eine optimale Wiederverwendung der Inhalte gewährleistet ist.
Wie kann der Dokumentationsprozess verbessert werden?
Das neue Software-Release ist fertig, aber die Dokumentation dazu nicht? Die Software hat neue Features, die nicht in die Dokumentation aufgenommen wurden? Das Review der Dokumentation ist zu langwierig und aufwändig?
Bei diesen und ähnlichen Fragen lohnt es sich, den Dokumentationsprozess genauer zu betrachten: Wer hat welche Aufgaben, wer erhält wann und von wem Informationen, mit welchen Tools wird gearbeitet und vieles mehr. Wir analysieren Ihren aktuellen Redaktionsprozess und geben Empfehlungen, wie der Prozess optimiert werden kann.