Fachbücher

doculine Archiv

Service

Aktuelle Artikel und Nachrichten rund um die technische Dokumentation finden Sie im Nachfolgemagazin der doculine news, den transline tecNews

Qualitätsmanagement und technische Dokumentation

Artikel erschienen in
Ausgabe Juli/August 1998

Von Peter Buck

Inhaltsübersicht:

• Gegenüberstellung Qualitätsmanagement – technische Dokumentation
• Bedeutung der ISO 9000er-Reihe für die Benutzerdokumentation
• Wesentliche Komponenten einer Dokumentation nach ISO 9000 ff.
• Fazit

Qualitätsmanagement nach der Normenreihe DIN EN ISO 9000 ff. war und ist in aller Munde. Die technische Dokumentation erlebt seit dem Inkrafttreten der EG-Maschinenrichtlinie einen noch nie dagewesenen Boom. Diese beiden Gebiete, die auf den ersten Blick keine gemeinsamen Berührungspunkte besitzen, sind sehr eng miteinander verschachtelt. Worin liegen jedoch diese Berührungspunkte?

Gegenüberstellung Qualitätsmanagement – technische Dokumentation

Die Normenreihe ISO 9000 ff. legt besonderen Wert auf die sorgfältige und gewissenhafte Planung aller durchzuführenden Qualitätsmaßnahmen. Zu diesen Qualitätsmaßnahmen gehören in erster Linie periodische interne und externe Audits sowie die ebenfalls regelmäßig durchzuführenden Management-Reviews.

Auch in Ihrer Abteilung der technischen Redaktion sollten Sie die Arbeiten planen. In der Praxis bedeutet das, die Arbeit in Projekte zu gliedern und mit den notwendigen Verantwortlichkeiten und Terminen zu versehen.

Die technische Dokumentation orientiert ihre Forderungen und Ziele zu einem Großteil an bestehenden Gesetzen, Richtlinien und Gerichtsurteilen. Eine solche Forderung z.B. aus der EG-Maschinenrichtlinie 89/392/EWG ist, daß die technische Dokumentation in Form einer Betriebsanleitung an den Verbraucher auszuhändigen ist. Darüber hinaus soll sie inhaltlich und gestalterisch ansprechend sein und zum Lesen animieren.

Bedeutung der ISO 9000er-Reihe für die Benutzerdokumentation

Die ISO 9000er-Normen haben für jedes Unternehmen, das sich nach einer dieser Normen ein Qualitätsmanagement-System aufgebaut hat oder es zertifizieren lassen möchte, erheblichen Einfluß auf die technische, aber auch sonstige Dokumentation (z.B. interne Dokumentation von Verfahren, Abläufen und Prozessen). Sollten Sie mit Ihrem Unternehmen also eine solche Zertifizierung anstreben oder durch den Markt zunehmenden Druck erfahren, sind Sie gut beraten, sich bei den Dokumenten des Hauses an die Normenforderungen anzulehnen.

Aus den Normen selbst (und auch aus dem gesunden Menschenverstand) lassen sich Forderungen ableiten, denen die technische Dokumentation genügen muß. Dies können z.B. sein:

• Wirtschaftlichkeit
• möglichst wenig Bürokratie
• Sicherheit
• Verfügbarkeit
• Änderbarkeit/Aktualisierbarkeit
• Verfahren zur Genehmigung und Herausgabe von Dokumenten etc.

Wesentliche Komponenten einer Dokumentation nach ISO 9000 ff.

Die in einem “guten“ Qualitätsmanagement-System integrierten Dokumente erheben den Anspruch, daß ein relativ unerfahrener Mitarbeiter oder Kunde vom fachlichen Inhalt ähnlich gut profitieren kann wie der Fachmann, der mit dieser Thematik schon seit Jahren umgeht. Das bedeutet, daß eine Betriebsanleitung immer die notwendigen fachlichen Informationen enthalten sollte, damit der Verbraucher das Produkt versteht und benutzen kann.

Die Dokumentation auf der Basis von Qualitätsmanagement-Systemen nach den ISO 9000er-Normen neigt meistens zu einem formalistischen Aufbau. Das ist nicht zu vermeiden und kann – sinnvoll und unbürokratisch angewandt – sehr hilfreich für die Einhaltung der angestrebten Qualität sein.

Diesen formalistischen Aufbau können Sie sich auch zunutze machen: Daraus läßt sich ein Raster ableiten, das auf alle Dokumente im Unternehmen anwendbar ist. Natürlich dürfen Sie dieses Raster dann nicht als Dogma ansehen, sondern vielmehr als Hilfestellung, um den Dokumenten eines Unternehmens ein einheitliches Erscheinungsbild zu geben. Damit unterstützen Sie auch das Corporate Design bzw. die Corporate Identity des Unternehmens.

Komponenten einer Dokumentation
1. Einführung	kurze Zusammenfassung und Erläuterung der Thematik allgemein verständliche Formulierungen keine Vorkenntnisse erforderlich klare und übersichtliche Gliederung
2. Sinn und Ziel	kurze und präzise Darlegung Bezug nehmen auf Risiken bei Nichteinhaltung oder Nichtbefolgung der Dokumentation
3. Geltungsbereich	Darstellen, wofür und unter welchen Bedingungen die Dokumentation zur Anwendung kommt eindeutige Festlegung, um spätere gerichtliche Auseinandersetzungen, z.B. im Rahmen der Produkthaftung, zu vermeiden
4. Verantwortlichkeiten,  Ansprechpartner	klare Festlegung, damit Kunden mit Fragen und Verbesserungsvorschlägen an den verantwortlichen Ansprechpartner herantreten können
5. Referenzen	Bezug auf andere relevante Dokumente benutzerfreundlich und leicht erkennbar
6. Definitionen	separates Anführen nur sinnvoll bei ausgedehnten Dokumentationen sonst: Erläuterungen im Text
7. Illustrationen, Ablaufdiagramme	Hilfsmittel zur Verdeutlichung von Abläufen Steigerung der Aufmerksamkeit des Anwenders
Tab. 1: Beispiele für die Komponenten einer Dokumentation und ihre Ausführung

Dieses Raster gibt den formalen Aufbau einer Benutzerdokumentation vor. Daneben sollten Sie sich als technischer Redakteur Leitsätze für die eigene Arbeit setzen. Wie die Leitsätze auf Unternehmensebene, so geben auch die Leitsätze der technischen Redaktion keine konkreten Handlungsanweisungen für die Praxis. Sie legitimieren Ihre Abteilung jedoch gegenüber den anderen Abteilungen, bestimmen dieKommunikationsstruktur und motivieren die Mitarbeiter in der Abteilung.

Für die technische Dokumentation gelten zwei übergeordnete qualitative Grundsätze:

Es gilt nun, aufbauend auf diesen Grundsätzen die Kundenerwartungenan die technische Dokumentation zu erarbeiten und daraus die qualitativen Leitsätze abzuleiten, die für die Arbeit der technischen Redaktion maßgebend sein sollen.

Die Anbindung zwischen der technischen Dokumentation und dem Qualitätsmanagement findet sich an einer solchen Stelle unter anderem in der geplanten, strukturierten und dokumentierten Vorgehensweise.

Fazit

Qualitätsmanagement und technische Dokumentation haben insbesondere bei der Steuerung von Dokumenten und der Steuerung von Qualitätsaufzeichnungen keine Berührungs-, sondern regelrechte Verzahnungspunkte. Das Qualitätsmanagement-System regelt die Planung und auch die Ausführung der technischen Dokumentation. Sinnvoll eingesetzt, kann ein QM-System die tägliche Arbeit des technischen Redakteurs erleichtern und ihn unterstützen.

Letzte Änderung: 31.10.2005 | Presse-Service | Disclaimer
© doculine Verlags-GmbH, ein Unternehmen der transline Gruppe