09.11.2016

Erstellung

Nachdem die Anforderungen an die Dokumentation während der Konzeptphase zusammengestellt sind, Produkt- und Zielgruppenanalyse sowie die Risikobeurteilung vorliegen und auch das Strukturierungs- und Modularisierungkonzept stehen, geht es nun um die Ausführung der Dokumentation.

Auch wenn es in der Praxis manchmal drunter und drüber geht und wenn es so einfach erscheint, ohne dokumentierte Konzepte gleich mit einer Betriebsanleitung zu beginnen, so wollen wir doch davor warnen: Das sorgfältige Definieren der Anforderungen an die Dokumentation, das Berücksichtigen der Zielgruppe und ihres Wissensstandes, das verantwortungsbewusste Auswerten der Risikobeurteilung, das und noch mehr sind die Grundvoraussetzungen für das Erstellen einer gelungenen Benutzerinformation.

Sorgfalt ist geboten!

Mängel bei dieser Vorbereitung können im Haftungsfall unmittelbar auf den verantwortlichen technischen Redakteur mit dem Argument der Fahrlässigkeit abgewälzt werden, vor allem, wenn er seine Vorgehensweise aus der Vorbereitungsphase nicht detailliert zum Nachweis seiner Sorgfalt in der sogenannten internen technischen Dokumentation nachvollziehbar beschrieben hat!

Vorausgesetzt also, dass Ihnen die notwendigen Unterlagen vorliegen, beginnen Sie mit dem Erstellen Ihrer Dokumentation.

Schwerpunkte Ihrer Arbeit sind:

  • Ausformulieren und Strukturieren der Texte in zielgruppengerechter Sprache

  • lesefreundliche Seitengestaltung und Navigationshilfsmittel, mit denen der Benutzer schnell das findet, was …

Autor: Prof. Dr. -Ing. Ulrich Thiele

Sie sehen nur einen Ausschnitt aus dem Produkt „Technische Dokumentation“. Wir bieten Ihnen die Möglichkeit, „Technische Dokumentation“ 30 Minuten lang live zu testen - sofort, ohne Registrierung und mit Zugriff auf fast alle Funktionen.

„Technische Dokumentation“ jetzt 30 Minuten live testen!