Inhalt:
|
Entwicklung
einer strukturierten Technischen Kundendokumentation
Allgemeine Angaben Diese Anleitung richtet sich in erster Linie an Technische Redakteure aus Firmen, deren kleinste Erzeugnis-Losgröße 1 ist, d.h., die keine Serien, sondern "Unikate" produzieren. Aus wirtschaftlichen Gründen arbeitet man bei derartigen Losgrößen mit Baugruppen (Modulen). In solchen Firmen (sicherlich die Mehrzahl aller mittelständigen Maschinenbaubetriebe) arbeiten ein oder mehrere Mitarbeiter (Redakteure) in der Technischen Redaktion, um die Kundendokumentation auftragsbezogen immer wieder neu zusammenzustellen. Diese Anleitung hilft jenen Technischen Redakteuren, sich ein Raster zu schaffen, um Informationen nicht wahllos, sondern zielgerichtet und prozeßorientiert zu sammeln und auszuwerten. Durch ein derartiges Verfahren wird sichergestellt, daß die Nutzer der Erzeugnisse wirklich alle für sie relevanten Informationen erhalten. Andererseits gewährleistet das Raster ein gleiches Aussehen verschiedener Erzeugnisbereiche. Auch wird bei technischen Änderungen die Austauschbarkeit von Textteilen erheblich erleichtert. Alle erwähnten Beispiele sind zufällig ausgewählt worden und erheben keinen Anspruch auf Vollständigkeit. Sicherlich ergibt sich für jede andere Maschinenbau-Firma ein anderer Lebenslauf des Erzeugnisses, eine andere Zielgruppe usw. Auch sind aus Gründen der Übersicht die Bereiche "Steuerung" und "Zulieferaggregate" nicht in erforderlichem Maße berücksichtigt worden. Vorarbeiten: Modulare Bauweise Prüfen Sie, ob Ihre Firma mit Baugruppen arbeitet, die funktionsbezogen zusammengestellt und benannt werden. Existieren keine entsprechenden Baugruppeneinteilungen, so legen Sie diese selbst fest. Existieren bereits Baugruppen, die nicht oder nur teilweise funktionsbezogenen Charakter haben, so können Sie natürlich ebenfalls Ihre eigenen Baugruppen und deren Bezeichnungen bilden. Diese Vorgehensweise erschwert allerdings erheblich die Kommunikation zwischen der Technischen Redaktion und weiteren Abteilungen des Hauses, da Sie jede Information dieser Abteilungen vor der eigentlichen Auswertung "umrechnen" müssen. Hinzu kommt, daß der Nutzer der Maschine Informationen aus Ihrer Firma nicht nur von Ihnen erhält. Er arbeitet (dokumentationsbezogen) mit einer Baugruppeneinteilung, die möglicherweise einer weiteren Einteilung in den Katalogen, Prospekten und Angebotstexten widerspricht... Vorarbeiten: Software, Regelwerke, Periodica Wählen Sie ein geeignetes Textverarbeitungsprogramm und/oder DTP-Programm aus. Beachten Sie hier die Auswirkungen auf die zukünftige Arbeit. Wechseln Sie später das Programm, kann das Folgen haben, die ggf. über das reine Umformatieren hinausgehen. Hilfestellung erhalten Sie z.B. über einen objektiven Vergleich aller gängigen Systeme vom Institut für technische Literatur (ITL) in München (Ansprechpartner: Dieter Gust).Siehe Artikel vom Dezember 2001 Prüfen Sie, welche Regelwerke Sie im formalen Bereich zu beachten
haben. Sie finden nachfolgend eine Auswahl der wichtigsten DIN-Normen,
die allerdings kein Anspruch auf Vollständigkeit erhebt.
Auch sind Regelwerke hinsichtlich Dokumentationen für spezielle Erzeugnisbereiche, wie Zentrifugen (DIN E24403 Betriebsanleitung für Zentrifugen) oder Förderbänder (VDI 3620 Leitfaden für die Aufstellung einer Betriebsanleitung für Stetigför-derer) veröffentlicht worden. Prüfen Sie, welche Unterlagen noch hilfreich seien können. Beispiele: Loseblattsammlungen, Periodica usw.
Empfehlung: CI-Ausarbeitungen großer Firmen wie SNI, um daran angelehnt eigene "Hausgesetze" zu entwickeln. Diese Pilot-Projekt-Maschine sollte (falls möglich) für den deutschen Markt bestimmt sein, da Erfahrungen gezeigt haben, daß sich kostenintensive Übersetzungen erst nach der Einarbeitungsphase rentieren. Generell sollte erst die Übersetzung durchgeführt werden, wenn absolut klar ist, das Systematik und Layout Hausgesetz geworden sind und der zu übersetzende Text in technischer, juristischer und stilistischer Sicht einwandfrei und vollständig ist. Nichts ist schlimmer, als einen Standardtextbau-stein(z.B. Sicherheit) lediglich aus stilistischen oder optischen Gründen zu ändern, der für alle Erzeugnisbereiche gilt und bereits in viele Sprachen übersetzt wurde. Die dabei entstehenden Kosten können nicht an reale Aufträge angehängt werden, son-dern müssen dem Allgemeinkostensatz zugeschlagen werden. Eigentliche Entwicklung der Dokumentation: Analyse des Lebenslaufes des Erzeugnisses
Nun ist es möglich, aus den vorhandenen Informationen die jeweilige Textart abzuleiten. Sie erkennen jetzt, daß die verschiedenen Lebensbereiche Ihrer Maschine vielfältige Informationen bei unterschiedlichen Personenkreisen notwendig machen. So benötigt der Kunde z.B. ein Technisches Datenblatt, einen Anschlußplan, eine Anleitung zur Wartung etc. Diese vielfältigen Informationen wiederum können aber bei gleichen Nutzern und "ähnlicher" Textart zusammengefaßt und optimiert werden. Es bietet sich beispielsweise an, alle Instandhaltungsanleitungen zu einer zusammenzufassen. Lt. DIN ist Wartung + Inspektion + Instandsetzung = Instandhaltung Unser Beispiel: Sie erkennen, daß der Nutzer unserer Dokumentation aufgrund seiner Qualifikation (Betriebsschlosser) in der Lage ist, die Anschlüsse lediglich mit den erforderlichen Technischen Daten, ohne weitere Begleittexte vorzunehmen. Deshalb leiten Sie ab in das Betriebsanleitungskapitel "Technische Daten" sowie in die Aufbauzeichnung. Notieren Sie daher "Datenblatt" und "Aufbauzeichnung" in der 3. Spalte Textart. Unser Beispiel: Da bereits vor Auslieferung der Maschine mit den erforderlichen Installationsmaßnahmen beim Kunden begonnen wird, erhält er für die Vorbereitende Tätigkeit (2. Zeile) ebenfalls ein Datenblatt einschließlich Aufbauzeichnung. Fassen Sie deshalb die Textart "Datenblatt" und "Aufbauzeichnung" in der 6. Zeile mit der Textart gleichen Namens in der 2. Zeile zusammen. 2. und 6. Zeile: Datenblatt und Aufbauzeichnung: Sehen Sie die Maschine als black box, so erkennen Sie Zu- und Abflüsse von Hilfsmitteln (Wasser, Luft), zu verarbeitende Produkte und Energie (Strom). Die gebündelten Informationen über die (hier pauschal so bezeichneten) Zu- und Abflüsse benötigt der Kunde vor Anlieferung der Maschine bzw. bei der Installation selbst. Beispielsweise müssen ihm für Druckluft alle Parameter (min. und max. Druck, Verbrauch, Anschlußmaß und -ort, Luftzustand) bekannt sein. |
Lebensabschnitt der Maschine | Nutzer der Dokumentation (Zielgruppe) | anzunehmende Qualifikation | Textart | Optimierung |
1. Planung und Auslegung der Maschine | •
Fertigungsleiter
• Produktionsleiter • Werksleiter • Geschäftsführer |
technisch hoch qualifiziert, Techniker oder Ingenieur | Leistungskatalog | Katalog |
2. Vorbereitende Tätigkeiten (Legen von Anschlüssen/ Leitungen, Fundamente) | •
Mitarbeiter der Instandhaltungsabteilung
• externe Montagefirma |
Maschinenschlosser oder ähnliches | Datenblatt
Aufbauzeichnung |
Datenblatt
Aufbauzeichnung |
3. Innerbetrieblicher Transport | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Allgemeines: Transport |
Betr.-Anleitung
Allgemeines |
4. Auspacken | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Allgemeines: Verpackung |
|
5. Aufbauen und Montage der Baugruppen | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Montage |
Betr.-Anleitung
Montage |
6. Anschließen | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Datenblatt
Aufbauzeichnung |
|
7. Funktionsprüfung | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Funktionsprüfung |
Betr.-Anleitung
Instandhaltung |
8. Erst-Inbetriebnahme | •
Mitarbeiter der Instandhaltungsabteilung
• externe Montagefirma |
Maschinenschlosser oder ähnliches | Betr.-Anleitung
Erst-Inbetriebnahme |
Betr.-Anleitung
Erst-Inbetriebnahme |
9. Rüsten/Betrieb | • Maschinenführer | branchenfremd, Ungelernter ggf. Ausländer | Betr.-Anleitung
Betrieb/ Einstellen von Parametern |
Betr.-Anleitung
Betrieb |
10. Wartung | •
Mitarbeiter der Instandhaltungsabteilung
• Maschinenführer |
Maschinenschlosser
oder ähnliches
branchenfremd, Ungelernter ggf. Ausländer |
Betr.-Anleitung
Wartung |
|
11. Inspektion | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Inspektion |
|
12. Instandsetzung | • Mitarbeiter der Instandhaltungsabteilung | Maschinenschlosser oder ähnliches | Betr.-Anleitung
Instandsetzung |
|
13. Beseitigung von Störungen (Trouble shooting plan) | •
Maschinenführer
• Mitarbeiter der Instandhaltungsabteilung |
Maschinenschlosser oder ähnliches | Betr.-Anleitung
Instandsetzung |
|
14. Umstellen/ Verkauf | •
Mitarbeiter der Instandhaltungsabteilung
• externe Montagefirma |
Maschinenschlosser oder ähnliches | Betr.-Anleitung
Allgemeines: Transport |
Zusammenführung
von abgeleiteten Textarten und Baugruppen
Im Kapitel "modulare Bauweise" wurde auf die Wichtigkeit von Baugruppen hingewiesen. Setzen Sie nun die eben abgeleiteten Textarten mit den Baugruppen Ihrer Pilot-Projekt-Maschine in Relation, so erhalten Sie eine Matrix. Diese Matrix dient als Leitfaden für Ihre weitere Vorgehensweise, denn sie gibt die Inhalte der zu erstellenden Textbausteine wider. Da es unnötig ist, jede einzelne Textart mit der Maschine selbst zu kombinieren und ein Datenblatt einschl. Aufbauzeichnung pro einzelner Baugruppe zu erstellen, fallen diese Textbausteine weg. Auf unser Beispiel bezogen, benötigt der Redakteur jetzt 6 (5 Baugruppen + Maschine) x 6 (Textarten) = 36 - 5 (Datenblatt/Aufbauzeichnung für 5 Baugruppen) - 4 (Textarten für die Maschine) = 27 Textbausteine. Ein Textbaustein enthält Informationen über eine Baugruppe, die mit einer Textart verknüpft ist. |
Betriebs-anleitung: | Datenblatt/ Aufbau-zeichnung | Allgemeines | Montage | Erst-Inbetrieb-nahme | Instand-haltung | Betrieb |
Maschine | 1 | 2 | ||||
Baugruppe 1 | 3 | 8 | 13 | 18 | 23 | |
Baugruppe 2 | 4 | 9 | 14 | 19 | 24 | |
Baugruppe 3 | 5 | 10 | 15 | 20 | 25 | |
Baugruppe 4 | 6 | 11 | 16 | 21 | 26 | |
Baugruppe 5 | 7 | 12 | 17 | 22 | 27 |
Entwicklung
der Gliederung
Für die Gliederung entscheiden Sie sich zwischen 2 Alternativen. Sie haben eben die Textarten mit den Baugruppen kombiniert. Sie haben jetzt folgende Wahl: • Möchten Sie in der 1. Ebene die Baugruppe und in der 2. Ebene
die Textgruppe (Beispiel 1), so fassen Sie die Baugruppen in Kapiteln zusammen,
die in Textarten unterteilt werden.
Beispiel 1
• Bevorzugen Sie die Textgruppe in der 1. Ebene und die Bausteine in der 2. Ebene (Beispiel 2), so legen Sie Ihre Kapitel entsprechend den Textgruppen an und unterteilen diese in Baugruppen. Beispiel 2
Achten Sie während des Betriebes auf ungewöhnliche
Geräusche. Prüfen Sie, ob ...
Dieter
Stötefalke
Auf seiner Homepage beschreibt Herr Stötefalke auch den Einsatz des Programmes DokuPro, das entwickelt wurde um die Erstellung großer Dokumentationen unter Word for Windows zu erleichtern. (Die Redaktion) |