Arten Technischer Dokumentation

Transkript

1 Prof. Rolf Schwermer Arten Technischer Dokumentation Inhalt Technische Dokumentation für den Vertrieb...2 Beispiel: Technisches Datenblatt...2 Beispiel: Preisliste...3 Beispiel: Prospekt...3 Technische Dokumentation für externe Kunden / Anwender...4 Beispiel: Betriebsanleitung...4 Beispiel: Ersatzteilkatalog...5 Beispiel: Schulungsunterlage...5 Betriebsinterne Technische Dokumentation...6 Entwicklungsdokumentation...6 Betriebsanweisungen...6 Qualitätsmanagementhandbücher (QM-Handbücher)...7 Notfall-Dokumentation...7 Systematik der Technischen Dokumentationsarten...9 Gegenüberstellung von zwei Dokumentationsarten...10 Dokumentationsarten nach Darstellungsperspektive...11

2 Technische Dokumentation für den Vertrieb Technische Dokumentationen werden bereits eingesetzt, bevor ein Produkt verkauft ist im sogenannten Pre sale -Bereich. Diese Pre-Sales-Dokumente enthalten Informationen mit darstellenden Charakter, häufig aber auch werblich-appellative Elemente, und dienen hauptsächlich der Verkaufsunterstützung. Beispiele: Produktbeschreibungen / Produktinformationen Datenblätter Kataloge Preislisten Prospekte technische Teile von Angeboten Beispiel: Technisches Datenblatt Technische Datenblätter trockene Details oder ansprechende Information Technische Datenblätter sollen die Anwendungsbereiche und Besonderheiten Ihres Produkts darstellen, Details vermitteln und dem Leser das Finden der für ihn relevanten Daten erleichtern mit anderen Worten die Kaufentscheidung zu Ihren Gunsten beeinflussen. 1 1 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH: abgerufen am Version vom

3 Beispiel: Preisliste Preislisten Produktauflistung oder Information mit Mehrwert Eine Preisliste hat einen schicken Umschlag, im Inhalt werden die Produkte mit zugehöriger Bestellnummer und Preis aufgelistet... Wenn es ein bisschen mehr sein darf, kann aus Ihrer Preisliste ein effektiver Baustein Ihrer Marketingmaßnahme werden. 2 Beispiel: Prospekt Produktwerbung Technik im Rampenlicht Was braucht es für eine gute Produktwerbung? einen guten Texter einen guten Grafiker einen guten Layouter und... einen der das Produkt kennt, versteht und deshalb optimal vermittelt. 3 2 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH, a. a. O. 3 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH, a. a. O. Version vom

4 Technische Dokumentation für externe Kunden / Anwender Dies sind die klassischen Dokumente, die in der Regel zum Einsatz kommen, wenn das Produkt bereits verkauft ist im After sale -Bereich und enthalten deswegen überwiegend darstellende Informationen. Der Hauptzweck dieser Dokumente ist es, den Anwendern den alle Funktionen umfassenden und sicheren Gebrauch des Produktes zu ermöglichen. Beispiele: Betriebsanleitungen / Betriebshandbücher Gebrauchsanleitungen Wartungsanleitungen / -handbücher Ersatzteilkataloge Schulungsunterlagen Lernanleitungen Beispiel: Betriebsanleitung Anleitungen Fluch oder Produktwerbung Der Gesetzgeber schreibt es vor - einem Produkt muss eine Betriebs- bzw. Bedienungsanleitung mitgegeben werden. Von vielen Herstellern als lästige Pflicht empfunden, von einigen als die vielleicht beste Werbung erkannt. Eine gute Anleitung unterstützt beim Umgang mit dem Produkt, macht es dem Anwender gut zugänglich und vermittelt somit einen positiven Eindruck. Kennen Sie eine bessere Werbung als zufriedene Kunden? Betriebsanleitungen und Handbücher Einsteinsche Gedankengänge oder Produkt ABC So einfach ist das einfach nicht, unser Produkt ist sehr komplex Natürlich ist es das! Und um so wichtiger ist es, diese komplexen Sachverhalte einfach und verständlich darzustellen. 4 4 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH, a. a. O. Version vom

5 Beispiel: Ersatzteilkatalog Ersatzteilkataloge Abgespeckte Stücklisten oder echte Bestellhilfen Notwendig sind sie, keine Frage aber wie aufwändig müssen sie sein? Ersatzteilkataloge erlebt man oft als Odyssee durch Querverweise und Zahlenkolonnen, für den Kunden schwer zu nutzen, für den Hersteller schwer zu pflegen. Da lohnt es sich schon über Automatismen nachzudenken. 5 Beispiel: Schulungsunterlage Schulungsunterlagen Schlafmittel oder Information erleben Das Thema ist so trocken, es gibt einfach nicht mehr her. Das ist nicht wirklich eine Ausrede für eingeschlafene Schulungsteilnehmer. Für jedes Thema lässt sich der richtige Ton finden, auch ohne deshalb gleich in die multimediale Trickkiste zu greifen. 6 5 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH, a. a. O. 6 Beispiel und Text von der Website der Technical Office Agentur für technische Kommunikation GmbH, a. a. O. Version vom

6 Betriebsinterne Technische Dokumentation Entwicklungsdokumentation Nach der VDI-Richtlinie 4500 Technische Dokumentation Benutzerinformation zählen zu Dokumenten der betriebsinternen Technischen Dokumentation z. B.: Pflichtenheft Konstruktionsunterlagen Fertigungsunterlagen / Arbeitsanweisungen Betriebsanweisungen Zur betriebsinternen Technischen Dokumentation zählen auch Betriebsanweisungen. Andere Bezeichnungen dafür sind: Arbeitsanweisungen Arbeitsplatzbeschreibungen Betriebsanweisungen sind Anweisungen und Angaben des Betreibers bzw. Verwenders von Einrichtungen, technischen Erzeugnissen, Arbeitsverfahren, Stoffen oder Zubereitungen an seine Mitarbeiter mit dem Ziel, Unfälle und Gesundheitsrisiken zu vermeiden. Einbezogen sein können auch der Sach- und der Umweltschutz. Bei der Erstellung von Betriebsanweisungen (...) sind neben den in einschlägigen Arbeitsschutz- und Unfallverhütungsvorschriften geforderten Verhaltensweisen auch arbeitsmedizinische Regeln sowie die speziellen Angaben des Herstellers in den Betriebsanleitungen zu berücksichtigen. 7 Der Betreiber von Arbeitsmaschinen hat (...) unter Berücksichtigung der vom Hersteller mitgelieferten Betriebsanleitung eine Betriebsanweisung aufzustellen. Die Betriebsanweisung muss Angaben über Inbetriebnahme, Bedienen, Rüsten, Wartung, Stillsetzen und Verhalten bei Störungen enthalten. 8 7 Zitat Berufsgenossenschaft Metall; Zeilenumbrüche von mir, RS 8 Unfallverhütungsvorschrift der Berufsgenossenschaft Chemie 43, Absatz 1; Zeilenumbrüche von mir, RS Version vom

7 Qualitätsmanagementhandbücher (QM-Handbücher) QM-Handbücher sind Bestandteil einer betriebsinternen Technischen Dokumentation und enthalten alle Informationen, die für eine Zertifizierung eines Betriebes nach ISO 9000 ff. notwendig sind. Sie bestehen aus folgenden Teilen: 1. Handbuch Qualitätsmanagement : enthält die Grundsätze des Qualitätsmanagements in dem Unternehmen und die Übersicht über die weiteren Dokumentteile 2. Verfahrensbeschreibungen = eine Dokumentation der betrieblichen Abläufe und der verantwortlichen Personen / Stellen 3. Arbeitsanweisungen = konkrete Beschreibung und Anleitung zu einzelnen Abläufen inklusive der zu dem Prozess zugehörigen Dokumente Notfall-Dokumentation Eine Notfall-Dokumentation (Notfallhandbuch) für Unternehmen soll alle vorhersehbaren Notfälle für ein Unternehmen abdecken: Brand, Wasserschaden, Ausfälle der Informationstechnologie usw. Notfallhandbücher werden z. B. für bestimmte Bereiche in Kernkraftwerken entwickelt. Um Notfallhandbücher erstellen zu können, sind sehr intime Kenntnisse des Unternehmens, umfangreiche Untersuchungen vor Ort und ein spezielles Know-how notwendig. Notfallhandbücher haben häufig einen großen Umfang und werden meistens unter Verschluss gehalten, da die Kenntnisse des Inhalts das Unternehmen angreifbar machen könnten. Mögliche Gliederung für ein Notfallhandbuch, dargestellt an einem Inhaltsverzeichnis: Inhaltsverzeichnis Notfall-Handbuch Teil A: Sofortmaßnahmen 1 Alarmierung im Notfall 1.1 Alarmierungsplan und Meldewege 1.2 Adresslisten betroffener Mitarbeiter 1.3 Festlegung konkreter Aufgaben für einzelne Personen/Funktionen im Notfall 1.4 Notrufnummern (z. B. Feuerwehr, Polizei, Notarzt, Wasser- und Stromversorger, Ausweichrechenzentrum, externes Datenträgerarchiv, externe Telekommunikationsanbieter) 2 Handlungsanweisung für spezielle Ereignisse 2.1 Brand 2.2 Wassereinbruch 2.3 Stromausfall 2.4 Ausfall der Klimaanlage 2.5 Explosion 2.6 Sabotage Version vom

8 2.7 Ausfall der Datenfernübertragungseinrichtung 2.8 Einbruch 2.9 Vandalismus 2.10 Bombendrohung 2.11 Streik / Demonstrationen Teil B: Regelungen für den Notfall 3 Allgemeine Regelungen 3.1 Notfall-Verantwortliche 3.2 Benennung der an der Durchführung der Notfallpläne beteiligten Organisationseinheiten, Kompetenzverteilung 3.3 Organisationsrichtlinien, Verhaltensregeln 4 Tabelle der Verfügbarkeitsanforderungen Teil C: Wiederanlaufpläne für kritische Komponenten 5 Wiederanlauf-Planung 5.1 Wiederanlauf-Plan für Komponente 1 (z. B. Host) Wiederbeschaffungsmöglichkeiten Interne / externe Ausweichmöglichkeiten DFÜ-Versorgung 5.1.4Eingeschränkter IT-Betrieb Wiederanlaufreihenfolge 5.2 Wiederanlauf-Plan für Komponente 2 (z. B. Drucker)... Teil D: Dokumentation 6 Beschreibung der IT-Systeme 6.1 Beschreibung des IT-Systems A (im Überblick) 6.1.1Beschreibung der Hardware-Komponenten 6.1.2Beschreibung der Software-Komponenten Bestandsverzeichnis der Systemsoftware Bestandsverzeichnis der zu dem IT-System gehörenden Systemdaten 6.1.3Beschreibung der Netzanbindungen des IT-Systems 6.1.4Beschreibung der IT-Anwendungen Bestandsverzeichnis der Anwendungssoftware Bestandsverzeichnis der zu einer IT-Anwendung gehörenden Daten Kapazitätsanforderungen einzelner IT-Anwendungen im Normalfall Minimale Kapazitätsanforderungen der IT-Anwendungen für den Notfall Wiederanlaufverfahren der IT-Anwendungen Datensicherungsplan 6.1.6Beschreibung der notwendigen Infrastruktureinrichtungen 6.1.7Sonstige Unterlagen (Handbücher etc.) 6.2 Beschreibung des IT-Systems B... 7 Wichtige Informationen 7.1 Ersatzbeschaffungsplan 7.2 Hersteller- und Lieferantenverzeichnis 7.3 Verzeichnis der Dienstleistungsunternehmen des Fachgebiets Sanierung Letztes Änderungsdatum: Version vom

9 Systematik der Technischen Dokumentationsarten Die folgende Übersicht folgt weitgehend der Systematik der VDI-Richtlinie 4500 Technische Dokumentation Benutzerinformation. für den Vertrieb (pre sale) für die Nutzung nach dem Kauf des Produktes (after sale) externe Technische Dokumentation Produktinformation Prospekt Datenblatt Katalog technischer Teil eines Angebotes Betriebsanleitung Betriebshandbuch Transportanleitung Installationsanleitung Montage- / Einbau- / Zusammenbauanleitung Inbetriebnahmeanleitung Bedien(ungs)- anleitung Reinigungsanleitung Wartungsanleitung Reparaturanleitung Entsorgungsanleitung Erstatzteilkatalog Lernanleitung / Tutorial Kurzanleitung / Sofortanleitung für Konsumgüter Produktinformation Prospekt Datenblatt Katalog interne Technische Dokumentation für Investitionsgüter Entwicklungsdokumentation Pflichtenheft Konstruktionsunterlagen Fertigungsunterlagen / Arbeitsanweisungen Gebrauchsanleitung Benutzerhandbuch Transportanleitung Installationsanleitung Montage- / Einbau- / Zusammenbauanleitung Bedien(ungs)anleitung Reinigungsanleitung Wartungsanleitung Reparaturanleitung Entsorgungsanleitung Erstatzteilliste Lernanleitung / Tutorial / Einführung Kurzanleitung / Sofortanleitung Betriebsanweisung Qualitätsmanagementhandbuch Notfalldokumentation Schulungsunterlage Version vom

10 Gegenüberstellung von zwei Dokumentationsarten Zwei Dokumentationsarten, die häufig in Betrieben genutzt werden, werden immer wieder miteinander verwechselt und sollen deswegen gegenübergestellt werden. Bezeichnungen (Synonyme) Wer erstellt die Technische Dokumentation? Was wird dokumentiert? (Dokumentationsgegenstand) Für wen (für welche Adressaten) wird die Technische Dokumentation erstellt? Welche Informationslücke wird durch das Dokument geschlossen? Warum wird die Technische Dokumentation erstellt? Um welche Dokumentationsart nach VDI 4500 handelt es sich? Betriebsanleitung / Betriebshandbuch Der Hersteller, z. B. die Herstellerfirma einer Drehmaschine Ein technisches Produkt, z. B. eine Drehmaschine Betreiber (z. B. derjenige, der die Drehmaschine kauft und in seinem Betrieb aufstellt und betreibt) Anwender (z. B. diejenigen, die mit der Drehmaschine arbeiten, sie warten, reparieren usw.) Evtl. weitere Adressaten, z. B. Fachhändler Alles, was die Adressaten wissen müssen, um die Maschine 1. in allen Funktionen 2. sicher nutzen zu können. Gesetzliche Verpflichtung bei Maschinen durch Gerätesicherheitsgesetz / EG-Richtlinie Maschinen Externe Technische Dokumentation für Investitionsgüter für die Nutzung eines Produktes (z. B. Drehmaschine) nach dem Verkauf Betriebsanweisung / Arbeitsanweisung Der Betreiber / Arbeitgeber, der z. B. eine Drehmaschine anschafft, in seinem Betrieb aufstellt und damit produziert Ein Arbeitsplatz, z. B. an einer Drehmaschine Mitarbeiter in einem Betrieb, die Aufgaben an einem bestimmten Arbeitsplatz erfüllen Alles, was die Mitarbeiter an diesem bestimmten Arbeitsplatz wissen müssen über 1. die eingeschränkten Funktionen der Maschine an diesem Arbeitsplatz 2. alle Sicherheitsaspekte an diesem Arbeitsplatz Gesetzliche Verpflichtung durch Vorschriften der Berufsgenossenschaften (UVV = Unfallverhütungsvorschriften) für alle Arbeitsplätze Interne Technische Dokumentation eines Arbeitsplatzes Version vom

11 Dokumentationsarten nach Darstellungsperspektive Darstellungsperspektive Gliederungsprinzip (erkennbar am Inhaltsverzeichnis) Produktorientierte Technische Dokumentation Nach Bestandteilen / Baugruppen / Menüs des Produktes gegliedert Aufgabenorientierte Technische Dokumentation Nach möglichen Aufgaben / Anwendungen / Handlungen der Benutzer gegliedert, die mit dem Produkt gelöst werden sollen / müssen / dürfen / können Lernorientierte Technische Dokumentation Nach Lernweg der Anwender didaktisch strukturiert: Vom Einfachen zum Schweren, Auswahl der Inhalte (nicht vollständig),... Sprachfunktionen (erkennbar an Formulierungen im Text) Beschreiben des Geräts / Gegenstands der Funktion, des Ablaufs Anleiten (Anweisen) zu Handlungen Lehren (z. B. Lernziele nennen, Beispiele geben,...) Erklären / Erläutern Warnen, Hinweisen Bewerten (= werbliche Aussagen, z. B. in Prospekten, Produktdatenblättern,...) Erklären, Erläutern (s. o.) Anleiten (s. o.) Beschreiben (s. o.) Beschreiben (s. o.) Erklären / Erläutern (s. o.) Warnen, Hinweisen (s. o.) Regeln aufstellen / Normen darlegen (z. B. Garantieleistungen, CE- Konformität) Version vom

12 Literatur Juhl, Dietrich: Technische Dokumentation. Praktische Anleitungen und Beispiele. Berlin, Heidelberg (Springer) 2002, ISBN Reichert, Günther W.: Kompendium für Technische Dokumentationen. Anwendungssicher mit Didaktisch-Typografischem Visualisieren. Leinfelden-Echterdingen (Konradin Verlag) 1991 Riedel, Falko; Walter, Klaus-Dieter; Wallin-Felkner, Christine: Praxishandbuch Technische Dokumentation: wirtschaftlich organisieren, systematisch erstellen, kundengerecht gestalten. Augsburg (WEKA Fachverlag für technische Führungskräfte); Loseblattwerk; Grundwerk: 1995, ISBN Seeger, Otto W.: Betriebsanleitungen, Betriebsanweisungen. Instrumente der Gesundheitsvorsorge, der Arbeitssicherheit und des Umweltschutzes. Teil 1: Arbeitsplatz-spezifische Betriebsanweisungen. Köln (Arbeitgeberverband der Metallindustrie) 1992, 4. Auflage, ISBN Seeger, Otto W.: Betriebsanleitungen, Betriebsanweisungen. Instrumente der Gesundheitsvorsorge, der Arbeitssicherheit und des Umweltschutzes. Teil 2: Handlungsanleitungen, Arbeitsplatzübergreifende Betriebsanweisungen, Ergänzende Merkblätter. Köln (Arbeitgeberverband der Metallindustrie) 1992, 4. Auflage, ISBN Version vom