Aktionen

Standardisierte Dokumentstrukturen verwenden

Aus PQWiki


SE-Disziplin

Bereich

Schnelligkeit
★★★
Einfachheit
★★★
Agilität
★★★

Ziele

* Erstellung technischer Dokumentation vereinfachen
  • Qualität und Lesbarkeit von Dokumenten erhöhen
  • Vollständigkeitsprüfung von Dokumenten erleichtern

Motivation/Problemstellung

Eine gut strukturierte, vollständige und verständliche Produktdokumentation zu erstellen ist anspruchsvoll und aufwändig. Obwohl hierfür bei vielen Herstellern kein ausgebildeter technischer Redakteur zur Verfügung steht, müssen die Dokumente hohen Qualitätsanforderungen genügen und die Dokumenterstellung soll zugleich möglichst effizient ablaufen.

Kurzbeschreibung

Vorlage verwenden.png
Die Verwendung standardisierter Dokument- und Inhaltsstrukturen vereinfacht die Erstellung vollständiger Dokumente und die Wiederverwendung bestehender Dokumentinhalte. Standardisierte Strukturen helfen dabei, die Qualität der internen und externen Produktdokumentation zu verbessern. Ein konsistenter Aufbau, der über alle Dokumente bzw. Dokumentarten hinweg verwendet wird, sorgt zudem für eine wesentlich einfachere Nutzung der Dokumente.

Input

Identifizierter Bedarf für eine technische Dokumentation

Output

Standardisierte, bei Bedarf angepasste Dokument- und Inhaltsstruktur

Rahmenbedingungen

Rolle (Ausführender)

Dokumentersteller

Werkzeuge, Hilfsmittel

Textverarbeitungsprogramm

Vorkenntnisse und Erfahrungen

-

Ort und Umgebung

Bildschirm-/Büroarbeitsplatz

Weitere Teilnehmer

-

Voraussichtliche Dauer

Abhängig vom Umfang und der Komplexität des Dokuments

Vorgehensweise

Vorbereitung

Die technische Dokumentation eines Produkts, die aufgrund interner bzw. externer Vereinbarungen oder gesetzlicher Bestimmungen erstellt wird, muss für die jeweilige Zielgruppe verständlich sein. Alle Dokumentationsbestandteile – z. B. Spezifikationen, Installations- und Benutzerhandbücher – sollten in sinnvolle und logische Teilstrukturen wie Kapitel und Abschnitte aufgeteilt sein, damit der Nutzer schnell Wissen und Fertigkeiten im Umgang mit dem Produkt erwerben kann und ohne Umwege alle Informationen findet, die er in der jeweiligen Situation benötigt. Gleichartige Informationen sollten nach Möglichkeit mit der gleichen, wiedererkennbaren Grobstruktur vermittelt werden. Regelmäßige Nutzer wissen dann, dass bestimmte Inhalte in allen Dokumenten an derselben Stelle zu finden sind. Prüfen Sie daher vor der Erstellung eines Dokuments, ob es eine passende Vorlage bzw. eine standardisierte Struktur gibt, die Sie im betreffenden Kontext nutzen können bzw. erstellen Sie bei Bedarf eine neue Dokumentstruktur.

Durchführung


Übernehmen Sie die passende Vorlage bzw. Struktur für Ihr Dokument und passen Sie diese bei Bedarf an den jeweiligen Kontext an.

Die Verwendung standardisierter Dokumentstrukturen unterstützt Sie bei diesen Tätigkeiten: • Nutzung der Inhalte (z. B. Durchsuchen, selektives Lesen), • Überprüfung der Dokumente (z. B. automatische Prüfung auf Vollständigkeit), • Wiederverwendung von Inhalten, • Informationsaustausch zwischen unterschiedlichen Stakeholdern und

• Einarbeitung neuer Mitarbeiter.

Nachbereitung

Wiederverwendete bzw. standardisierte Dokumentstrukturen müssen oft an domänen-, unternehmens- oder projektspezifische Gegebenheiten angepasst werden. Wurden für ein Dokument bereits Vorarbeiten gemacht (z. B. haben externe Stakeholder bereits ihre Anforderungen an ein zu entwickelndes Produkt erfasst und kategorisiert), so behalten Sie im Zweifel die Gliederung dieser Vorarbeiten bei oder Sie passen Ihre Dokumentstruktur für diesen Bereich an.

Gütekriterien/Empfehlungen

Die Dokumentstruktur muss ausreichend flexibel sein, damit erforderliche Anpassungen an den Dokumenten vorgenommen werden können. Die Struktur muss sich außerdem am Informationsbedarf und Kenntnisstand der jeweiligen Zielgruppe orientieren. Für die Endanwender eines Produkts empfiehlt sich in der Regel ein prozess- bzw. handlungsorientierter Aufbau, für Entwicklungs- und Wartungspersonal eher ein modul- oder funktionsorientierter Aufbau. Um die Nutzung zu vereinfachen, können Sie jedes Kapitel mit einer kurzen Einleitung versehen (z. B. zu den Zielen und Inhalten des Kapitels). Um den Wiedererkennungswert der Dokumente weiter zu erhöhen achten Sie auf eine konsistente Verwendung von Layout, Typografie, Textstrukturierungsmitteln, Bildern, Piktogrammen, Terminologie und Abkürzungen.

Risiken

Wenn Sie im Rahmen der Entwicklung innovativer Produkte existierende Dokumentstrukturen bzw. -inhalte wiederverwenden (z.B. Spezifikationen von Vorgängerprodukten), so besteht die Gefahr, dass Sie bei der anschließenden Umsetzung in bekannte, schematische Lösungen verfallen.

Einordnung in das PQ4Agile-Qualitätsmodell

Schlagworte

Technische Dokumentation, Produktdokumentation

Weiterführende Informationen

Informationen im Internet

Literatur

*http://de.wikipedia.org/wiki/Technische_Dokumentation