itk-logo

 

ASD S1000D und technischer Redakteur


ASD und AIA haben in Nachfolge der AECMA Normenarbeitskreise übernommen, deren Ergebnisse für technische Redakteure interessant sind: Specification 1000D und Specification 2000M - kurz S1000D und S2000M.

Inhalt:

  1. Das Ziel: Interaktive Elektronische Technische Dokumentation (IETD)
  2. S1000D: Ein SGML-Standard für logistische Dokumentation
  3. S2000M: Ein SGML-Standard für Ersatzteillisten und Logistik
  4. Was bedeutet die S1000D für die Arbeit des technischen Redakteurs?

Das Ziel:
Interaktive Elektronische Technische Dokumentation (IETD)

Das Ziel der hier diskutierten Normungsbestrebungen ist eine einheitliche Basis für interaktive elektronische Dokumentation. Dabei geht es nur zum kleineren Teil darum, die Papierberge einzudämmen – alte Phi-mal-Daumen-Regel: Ein Satz komplette Dokumentation für ein Verkehrsflugzeug in Papierform wiegt so viel wie das Flugzeug selber. Da kommen dann schon mal über 100 Tonnen zusammen.

Der Nutzer soll mit dem Ausgabesystem (Viewer) mehr tun können als mit dem Acrobat Reader. Ausgangspunkt mußte deshalb ein System sein, das mit Inhaltliche Auszeichnung und Strukturierung arbeitet. Ich fand keine Information darüber, warum es unbedingt SGML sein mußte. Diese Aktivitäten sind schon sehr lange unterwegs. Auf vergeichsweise neue Technik wie XML oder Topic Maps (ISO 13250) reagiert der Standard deshalb erst langsam.

Jenseits der Normen und einiger einführender Präsentationen und Artikel ist die Informationsbeschaffung sehr mühsam. Läßt man sich die Bezeichnung IETD langsam auf der Zunge zergehen, scheinen folgende Anwendungen realistisch:

  • Auflösen von Verweisen. Je komplexer ein Produkt ist, um so häufiger werden bestimmte Arbeiten in unterschiedlichen Zusammenhängen ausgeführt – etwa der Ausbau eines Aggregates, um den Bereich dahinter erreichen zu können, oder ein abschließender Abgleich. Der Viewer kann die bislang unvermeidlichen Verweise auflösen und dem Nutzer eine lineare Arbeitsanweisung präsentieren.
  • Verschränken der Dokumentation mit speziellen Eigenschaften eines bestimmten Gerätes. Der Servicetechniker gibt Seriennummer und diverse Meßgrößen wie Betriebsstunden in seinen Rechner ein und erhält einen Ablaufplan für die genau jetzt fälligen Arbeiten. Künftig wird das Produkt wohl direkt mit dem Viewer kommunizieren und so selbst die benötigten Arbeiten anfordern.
  • Verschränken mehrerer Arbeitsabläufe. Falls etwa zwei Arbeiten mit jeweils den gleichen Abgleicharbeiten abgeschlossen werden müssen, erscheint diese Nacharbeit im Arbeitsplan nur einfach.
  • Neuartige Ausgabemöglichkeiten der Dokumentation. Schon heute gibt es Datenbrillen und andere tragbare Ausgabeeinheiten. SGML-Dokumente lassen sich für die Ausgabe äußerst flexibel aufbereiten, sicher auch für solche Anwendungen. So weiß der Viewer, was ein einzelner Arbeitsschritt ist oder welche Spezialwerkzeuge jeweils benötigt werden. Ehe der Techniker also in eine enge Ecke kriecht, kann er so genau die benötigten Werkzeuge und Materialien zusammenpacken und den Kollegen heran rufen, den er gleich brauchen wird. Mit dem gesprochenen Kommando weiter zeigt ihm die Datenbrille die Anleitung für den nächsten Arbeitsschritt.

S1000D:
Ein SGML-Standard für logistische Dokumentation

Die S1000D gibt den Rahmen für die komplette Dokumentation von Flugzeugsystemen vor, speziell im militärischen Bereich. Es gibt auch Bestrebungen, diese Normen für erdgebundene Fahrzeuge zu erweitern.

zur Normung gehört eine Liste aller angemeldeten Produkte. Diese Anmeldung ist Voraussetzung, weil der darauf hin vergebene Model Identification Code Teil der Bezeichnung jedes einzelnen Dokumentationsbausteins ist. Damit kann dann jeder Hersteller ohne weitere Koordination garantiert eindeutige Bezeichnungen für seine Dokumentationsbausteine vergeben. Schließlich treffen die Produkte verschiedener Hersteller später beim Kunden aufeinander – und deren Dokumentationen in ein und demselben Viewer. Oder unterschiedliche Produkte enthalten die gleichen Komponenten eines Drittherstellers, der seine eigene normkonforme-konforme Dokumentation liefert.

Die S1000D definiert vor allem drei Dinge:

  1. Ein Klassifizierungssystem für alle Teile der Dokumentation.
  2. Eine Struktur für jeden einzelnen Dokumentationsbaustein. Da steht nicht nur, daß ein Warnhinweis stets vor, nicht hinter, dem betreffenden Handlungsschritt zu stehen habe, sondern es gibt auch Platz umfangreiche Metadaten: notwendige Vor- und Nacharbeiten, Qualifikation des benötigten Personals, Arbeitszeitvorgaben und vieles mehr.
  3. Datenbankstrukturen, um Dokumentationsprojekte zu managen und die Dokumentation nutzbar zu machen. Letzteres ist außerordentlich wichtig, um eine Nutzung der Dokumente unabhängig von der speziellen Infrastruktur des Erstellers, in einem "Viewer", zu ermöglichen. Die Dokumentationsbausteine kennen ja immer nur ihr unmittelbares Umfeld, nicht das große Bild.

Für den deutschsprachigen Redakteur wohl nicht ganz so entscheidend sind die Vorgaben für ein Simplified English.

Um den Detailgrad dieser Norm zu beleuchten, sei ein Data Module Code konstruiert: 1A-A-293003-01A-231-A-A ist die Bezeichnung für einen Dokumentationsbaustein, der das Entlüften einer Hydraulik-Anzeigeeinheit (vulgo Manometer) beim Eurofighter im eingebauten Zustand beschreibt.

Weitere Informationen und Teile der S1000D sind über die Website der Technical Publications Specification Maintenance Group (TPSMG) kostenlos verfügbar.

S2000M:
Ein SGML-Standard für Ersatzteillisten und Logistik

Was hier als Ersatzteillisten bezeichnet wird, ist bedeutend mehr als nur eine Tabelle: Das Produkt wird nach vielen Vorschriften aufgegliedert, alles wird mit Explosionszeichnungen illustriert. Wer die typischen Unterlagen aus dem mittelständischen Maschnenbau kennt, dem werden bei einem Werk nach S2000M die Augen übergehen. Dabei sollten die zitierten Maschinenbauer es eigentlich besser wissen: Es gibt Statistiken, daß bis zu 2/3 aller ausgelieferten Ersatzteile sich als Fehllieferungen herausstellen, weil der Techniker vor Ort das gesuchte Teil nicht ausreichend sicher identifizieren kann.

Die S2000M ist ganz wesentlich eine Arbeitsgrundlage für den technischen Illustrator. Der technische Redakteur muß sich damit vor allem dann intensiv auseinandersetzen, wenn er oder sie das Produkt aufgliedern muß. Bedeutend einfacher ist der Standardjob: Zum Dokumentationsbaustein die benötigten Ersatzteile zusammenzusuchen. Das kann aber auch noch komplex genug sein, wenn man etwa einen Sprengring sucht und der bei der räumlich benachbarten, aber logisch völlig anders eingeordneten Rückwand untergebracht ist.

Der Vollständigkeit halber sei erwähnt, daß sich die S2000M um die kompletten Abläufe und Verfahren der Materialwirtschaft kümmert. Aber damit verlassen wir den Bereich, der für den technischen Redakteur interessant ist.

Was bedeutet die S1000D
für die Arbeit des technischen Redakteurs?

Vor allem eines: Die Zeit der freischaffenden Künstler ist vorbei. Praktisch jeder einzelne Satz muß nach genauen Vorgaben konstruiert werden. Das war im militärischen Bereich zwar theoretisch auch bislang schon so, jetzt wird es aber maschinell geprüft. Bislang hielten sich die Prüfer des Kunden doch eher an Formalem fest: Warum ist der Änderungsbalken auf dieser Seite breiter als zwei Seiten vorher? Die Dokumentationserstellung ist zwangsweise stark arbeitsteilig, wobei wohl meist hierarchische Strukturen entstehen:

  • Die erfahrensten Kollegen oder auch Logistiker teilen die Dokumentationsbausteine ein und vergeben die Data Module Codes (DMC). Ihre Arbeit speichern sie zu wesentlichen Teilen in einer Datenbank mit normierter Struktur.
  • Die meisten Kollegen bekommen DMCs zugeteilt und erstellen dann die einzelnen Dokumentationsbausteine. Ausgangspunkt für diese Arbeiten ist neben der Ersatzteilliste (nach S2000M) die Datenbank mit den bereits definierten DMC, um den eigenen Dokumentationsbaustein in das ganze Geflecht der Dokumentation einzupassen.
  • Ein Schlußredakteur muß u.a. sicherstellen, daß die einzelnen Dokumentationsbausteine auch zusammenpassen. Das ist aber bedeutend unübersichtlicher als bei herkömmlicher Dokumentation: Je nach Einsatzzweck kann der Viewer die Dokumentationsbausteine in völlig unterschiedlicher Reihenfolge zusammensetzen. Auch deshalb ist die genaue Einhaltung der Vorschriften so wichtig.

Nach diesen Spezifikationen erstellte Dokumentationen sind zwangsweise sehr umfangreich. Das ergibt sich nicht nur aus der Komplexität der beschriebenen Produkte, sondern auch aus der benötigen Infrastruktur. Noch gibt es sehr wenige Werkzeuge, die man fertig kaufen und kurzfristig einsetzen könnte. So mancher Dienstleister preist nicht umsonst sein, im eigenen Haus mit vielen Mannjahren Aufwand konstruiertes, kompatibles Verwaltungs- oder Autorensystem an. Auch sollte man nicht vergessen, daß es sich hier um ein ausgewachsenes SGML-System handelt, das sich nicht auf die, aus gutem Grund eingeführten, Vereinfachungen aus der XML-Welt verlassen kann.

Nicht verbessen darf man auch, daß das Erstellen inhaltlich strukturierter Dokumente noch längst nicht Stand der Technik ist. Eine repräsentative Untersuchung der tekom e.V. [1] aus dem Jahr 2002 hatte das Ergebnis, daß zwar ... viel von XML geredet [werde], konkrete Lösungen aber noch eher selten umgesetzt seien. Ich sehe auch an verschiedenen Stellen Hinweise auf Eigenentwicklungen an Autorenwerkzeugen. Wer hier und jetzt einsteigt, muß also mit recht unkomfortabler Arbeitsumgebung und wohl auch so manchem Provisorium rechnen.

Der Berufseinstieg als Redakteur

Eines muß von Anfang an klar sein: Dies ist eine Disziplin für Marathonläufer, nicht für Sprinter. Wer Projektlaufzeiten von Wochen oder Monaten kennt, muß völlig umdenken. Um ein aktuelles Projekt zu nennen: Der Eurofighter wurde in den 80er Jahren des letzten Jahrhunderts als Jäger 90 geboren und wird nach aktuellen Angaben des Bundesrechnungshofes noch wenigstens fünf Jahre brauchen, um seine volle Einsetzbereitschaft zu erreichen – 20 Jahre Entwicklungszeit und weitere 30 Jahre Praxiseinsatz sind auf diesem Gebiet völlig normal. 10 Mannjahre sind einen handelsübliche Projektgröße. Das macht dieses Gebiet zu einer Domäne für die großen Dienstleister, die meist schon langjährige Geschäftsbeziehungen pflegen. Da fliegt jemand nur raus, wenn ein großes Projekt stirbt oder der Dienstleister massiv Unfug treibt.

Verständlich ist auch, daß eher der Ingenieur mit sprachlicher Kompetenz denn der Pädagoge gefordert ist: Die Produkte sind komplex und niemand kommt da ran, der keine Schulung genossen hat. In meiner Bundeswehrzeit mußte ich erst mal eine Ausbildung in der Stammeinheit machen, ehe ich auch nur eine Wartungstür öffnen durfte.

Die Kollegen aus der Rüstungsindustrie überschätzen meiner Meinung nach deutlich ihre Spezialisierung, wenn sie technische Redakteure aus anderen Bereichen grundsätzlich als ungeeignet aussortieren – meiner Meinung nach gängige Praxis. Ich kam da auch nur rein, weil ich schon Erfahrung mit inhaltlich strukturierten Dokumenten hatte und eine Ingenieurausbildung vorweisen konnte.

Das hindert aber manche Personalberater nicht daran, von Stundensätzen gegenüber dem Endkunden von weniger als 50 EUR zu reden und auf Arbeitnehmerüberlassung zu bestehen. Zwar sind die Zeiten vorbei, als in diesem Bereich für das Erstellen einer Seite Dokumentation wohl über 1.000 DM gezahlt wurden. Aber auch bei Industriepreisen im Bereich 200 – 300 EUR sollte eine vernünftige Bezahlung hoch qualifizierten Personals möglich sein.

Literatur

[1] Schäfer, Gregor: Konkrete XML-Lösungen noch eher selten: Ergebnisse des Projekts "Adaptive READ"
in: technische Dokumentation 5/2002, S. 36ff
TOP
Alexander von Obert * http://www.techwriter.de/beispiel/asdaiasp.htm
Letzte Änderung: 25.08.03 (Erstfassung)


Startseite
Suche

Eigene Produkte

Was ist Single-Source-Publishing?
ASD S1000D und technischer Redakteur

Informelles Lernen

Elektronik
Mobilbetrieb auf 10m
ASD S1000D und technischer Redakteur