Workflow-Optimierung durch Technische Dokumentation
Betriebsanleitungen, Wartungshandbücher oder Bedienungsanleitungen sind Bestandteile des Produktes. Trotzdem wird die Konzeption und Herstellung der Dokumentationen oft noch als lästige Pflicht gesehen, die mal eben so nebenbei durchgeführt wird. Wenn Handbücher für jedes Produkt bei 0 beginnen oder durch Kopieren bestehender Texte starten, entstehen schwer zu pflegende fehleranfällige Dokumentationen, unter Einsatz von viel zu viel Arbeitszeit. Auch die informationsgebenden Abteilungen und Mitarbeiter/innen werden durch ständiges Nachfragen oder Korrekturlesen stark belastet. Gerade bei komplizierten Produktstrukturen oder häufigen Updates sind solche Arbeitsmethoden ein unnötig hoher Kostenfaktor.
Die für die Fertigstellung der Dokumentationen verwendete Zeit kann durch professionelle Textstrukturen und einen optimierten Workflow erheblich verkürzt werden.
Dazu muss zunächst analysiert werden, wo im Produktionsprozess die benötigte Information entsteht und wie sie bereit gestellt werden kann. Den Informationsquellen innerhalb der Firma werden dann die einzelnen Teile der Dokumentation zugeordnet. Für jedes neue Produkt, Projekt oder Update können dann die Informationen einfach aus den zugeordneten Quellen gezogen werden. Das kann automatisiert über eine Datenbank oder Dokumentvorlagen realisiert werden oder durch Organisation und Absprache. Es erübrigt sich bei diesem Verfahren ein zeitaufwendiges Korrigieren der Dokumentation durch die technischen Spezialisten. Wird die Informationsübergabe durch die Quellen angestoßen, kann zudem sicher gestellt werden, dass die Dokumentation immer auf aktuellem Stand ist.
Auch für die informationsgebenden Abteilungen kann die Bereitstellung der für die Dokumentation benötigten Daten ein Gewinn sein. Die benötigten Informationen müssen häufig sowieso im Vorfeld verfügbar sein, z.B. für Risikoanalysen, in Form von Spezifikationen oder Ähnlichem. Werden passende Dokumentvorlagen, Datenbankstrukturen oder andere Ablagesysteme geschaffen, ergibt sich ein Gewinn für beide Seiten. Dieses 'Single Sourcing' in der Dokumentation ist zugleich die beste Voraussetzung für die Verwendung einer einheitlichen Terminologie in der Firma.
Meine Leistungen im Überblick:
Konzeption und Erstellung von
- Bedienungs- oder Betriebsanleitungen Wartungsanleitungen, Installationsbeschreibungen Anwendungshandbüchern
- Kontextsensitiven Online-Hilfen
- Pflichtenheften oder Spezifikationen,
- Leistungs- oder Servicebeschreibungen
- Arbeitsanweisungen
- Schulungsmaterial
- Vorlagen für Textdokumente und Formulare aller Art
Überarbeitung bestehender Dokumentation
- Anpassung des Layouts / Vorlagenerstellung
- Anpassung an gesetzliche Vorgaben
- Einfügen von Automatisierungen
- Konvertierung in andere Dateiformate
- Qualitätsprüfung, Durchführung von Usability Tests
- Aktualisierung und Kontrolle des Inhalts
Mitarbeiter/innen-Schulung und Einweisung in
- eingesetzte Software (s. folg.)
- Pflege der entstandenen Dokumente
Einsatz von
- Microsoft®Office
- OpenOffice.orgTM
- Adobe®Framemaker®
- Adobe®Acrobat®
- Adobe®InDesign®