S1000D in Theorie und Praxis

Dokumentation nach S1000D – eine Anforderung, die in der Technischen Dokumentation immer häufiger auftaucht. Wer dann anfängt, sich mit dieser Spezifikation zu beschäftigen, ist schnell von den bis zu 3.700 Seiten überfordert. Im folgenden Artikel möchte ich Ihnen einen kurzen, klaren Überblick geben und Ihnen die Grundlagen zu diesem komplexen, aber faszinierenden Thema vermitteln.

S1000D ist eine internationale Spezifikation für die Erstellung, Verwaltung und Bereitstellung technischer Publikationen zu komplexen Produkten. Zu Beginn für die europäische militärische Luftfahrt entwickelt, wird sie heute in zahlreichen Branchen eingesetzt: von der Wehrtechnik über Schienenfahrzeugtechnik, Schiffbau und Windkraft bis hin zu Projekten im Maschinenbau. Sie ist frei verfügbar, jede Ausgabe kann zusammen mit Zusatzdaten von der Website www.s1000d.org heruntergeladen werden.

Die Spezifikation dient dazu, die Erstellung und Pflege Technischer Dokumentation für komplexe Produkte zu vereinheitlichen und medienneutral aufzubereiten, während des gesamten, oft langen Lebenszyklus des Produkts.

S1000D ist eng in das Konzept des „Integrated Product Support“ (IPS) – früher „Integrated Logistic support“ (ILS) eingebettet (Inf. 01). IPS soll sicherstellen, dass ein komplexes Produkt mit vielen Projektpartnern während seiner gesamten Lebensdauer, von der Planung bis hin zur Ausmusterung, effizient betrieben und gewartet werden kann. Dazu gehören Wartungsplanung, Materialmanagement, Schulung und Training für das Personal, Ersatzteilversorgung und eben die Technische Dokumentation. Um dieses Konzept bestmöglich umzusetzen, gibt die ASD (AeroSpace and Defence Industries Association of Europe) eine ganze Gruppe von Spezifikationen heraus, die so genannte „S-Series“.

Historie, Entwicklung und Einsatz

Aktuell wird die Spezifikation gemeinsam von ASD, AIA (Aerospace Industries Association, USA) und ATA (Air Transport Association, USA) gepflegt. Wie ihre Entwicklung von 1980 bis heute verlaufen ist, zeigt der Info-Kasten oben (Inf. 02).

Der Standard wurde in mehreren Ausgaben veröffentlicht, den so genannten Issues, aktuell von Issue 1 bis Issue 6. Jede neue Ausgabe enthält Korrekturen, zusätzliche Funktionalitäten und Anpassungen an neue Technologien.

Die Spezifikation wird von einer dynamischen und engagierten Community weiterentwickelt. Die strategische Richtung gibt das Steering Committee vor, Working Groups und Task Teams bearbeiten dann konkrete Themen. Jährlich findet eine S1000D User Conference statt. Man kann sagen: ein Familientreffen aller S1000D-Aficionados. In all diesen Gremien arbeiten Industrievertreter und -vertreterinnen, Anwender bzw. Anwenderinnen sowie das Militär eng zusammen.

Ziele der Spezifikation

Ziel der S1000D ist die konsistente Erstellung Technischer Dokumentation, maximale Wiederverwendung von Inhalten und effiziente, verlustfreie Zusammenarbeit zwischen verschiedenen Projektpartnern. Um dieses Ziel zu erreichen, enthält die S1000D umfangreiche und auch detaillierte Informationen – aufgelistet in Abbildung 01.

Abb. 01 Detaillierte Informationen nach S1000D. Quelle Pia Grubitz

In den neueren Issues wird die Integration in IPS-Prozesse mit Schnittstellen zu den anderen IPS-Spezifikationen und ERP-Systemen (etwa SAP) immer wichtiger. Ein Beispiel dafür zeigt der Info-Kasten (Inf. 03).

Grundprinzipien von S1000D

Prinzip 1, Datenmodule DM: Im Zentrum von S1000D steht das Datenmodul (DM). Ein DM ist eine vollständige, in sich geschlossene Informationseinheit, die alle Informationen enthält, die Anwender und Anwenderinnen brauchen, um eine bestimmte Aufgabe oder ein bestimmtes Objekt vollständig zu verstehen oder zu bearbeiten. Das ist zum Beispiel eine komplette Arbeitsanweisung oder Funktionsbeschreibung (Abb. 02).

Abb. 02 Datenmodul (Titelseite) mit kompletter Funktionsbeschreibung. Quelle Pia Grubitz

DMs sind versionierbar, medienneutral und möglichst wiederverwendbar. Damit kann dieselbe Information in unterschiedlichen Handbüchern oder Systemen verwendet werden. Die Datenmodule werden im XML-Format geschrieben (früher auch SGML), mit S1000D-XML-Schemas oder DTDs.

Neben den tatsächlichen Inhalten enthält jedes DM auch Metadaten. Im „Kopfbereich“ der XML-Datei stehen die Informationen über den eigentlichen Inhalt. Das DM ist also selbstbeschreibend und damit nicht abhängig von einer bestimmten Software zur Bearbeitung und Verwaltung. Wichtige Metadaten sind zum Beispiel der DM-Code, der technische Name, der Informationsname und die verantwortliche Organisation.Aus diesen einzelnen DMs werden Publikationen in vordefiniertem Umfang und Aufbau zusammengestellt. Der Redakteur bzw. die Redakteurin schreibt also immer einzelne DMs, nie ganze Handbücher.

Prinzip 2, Datenmodulcode DMC: Jedes Datenmodul bekommt einen eindeutigen Data Module Code (DMC), der aus verschiedenen Elementen besteht (die Kürzel der Elemente finden Sie in Abbildung 03, oberhalb des Codes).

Abb. 03 Aufbau eines Data Module Codes. Quelle Pia Grubitz; S1000D

Der DMC (Abb. 03) lässt sich grundsätzlich in zwei Bereiche unterteilen: einen systembezogenen Teil, der das Objekt oder Gerät beschreibt, auf das sich das DM bezieht (hier blau dargestellt), und einen inhaltsbezogenen Teil, der die Art und Bedeutung der enthaltenen Informationen beschreibt (hier grün dargestellt). Für einen ersten Überblick genügt es, sich drei Schlüsselelemente aus dem DMC zu merken:

• MI (Model Identifier): Der MI legt das Projekt fest, zum Beispiel „1B = Eurofighter“. Für militärische Projekte werden die MI durch die NSPA (NATO Support and Procurement Agency) festgelegt und gepflegt.
• SNS (Standard Numbering System): Der SNS beschreibt in drei Ebenen, zu welchem Teilbereich des Produktes das Datenmodul geschrieben wird, zum Beispiel „29-10-05 = Hydraulik → Haupt- system → Tank“. Die ersten beiden Ebenen des SNS werden durch die S1000D vorgegeben bzw. vorgeschlagen.
• IC (Information Code): Der IC sagt aus, welche Art von Information das Datenmodul enthält, zum Beispiel „720 = Installationsanleitung“. Die Infocodes werden durch die S1000D vorgegeben bzw. vorgeschlagen.

Alles Weitere im DMC (etwa Variante oder Einbauort) ist Detailtiefe, die man im Projekt lernt. Ein Beispiel eines fiktiven DMC gemäß S1000D zeigt der Info-Kasten rechts (Inf. 04).

Prinzip 3, Datenmodultypen: In S1000D gibt es verschiedene Informationsklassen, die oberflächlich vergleichbar sind mit „Topic-Typen“. Die am meisten verwendeten Datenmodultypen sind:

• Procedural DM – Schritt-für-Schritt-Anleitungen für Montage, Wartung oder Reparatur
• Descriptive DM – Funktions- und Aufbaubeschreibungen eines Systems, Subsystems oder einer Baugruppe
• Fault DM – Anleitungen zur Fehlersuche und Störungsbehebung
• IPD – illustrierte Ersatzteillisten
• Maintenance Planning DM – Listen zur Wartungsplanung

Jeder dieser Datenmodultypen basiert auf einer XML-Struktur mit einer jeweils eigenen DTD/XSD. Damit wird eine einheitliche und zielgerichtete Struktur je Informationsart gewährleistet.

Prinzip 4, Data Module Requirement List (DMRL): Die DMRL listet alle für ein Projekt benötigten Datenmodule auf. Sie wird möglichst früh im Projekt in Zusammenarbeit aller Projektpartner erstellt und laufend aktualisiert, wenn sich die Konfiguration des Produkts ändert. In der Technischen Redaktion wird dann diese Planungsliste mit Leben gefüllt, die Datenmodule werden mit Inhalten versehen.

Prinzip 5 Common Source Database (CSDB): In der CSDB werden alle Inhalte eines Projekts verwaltet. Dazu zählen DMRL, DM, Illustrationen, Multimedia und Regeldateien. Mit ihrer Hilfe werden alle Aktionen zu den Inhalten gesteuert wie Versionierung, Freigaben, Publikationszusammenstellungen und Austauschprozesse zwischen allen Projektpartnern (Hersteller, Auftraggeber und Dienstleister).

S1000D macht für die CSDB keine Vorgaben bezüglich des zu verwendenden Tools. Das Werkzeug muss möglichst viele Vorgaben der S1000D umsetzen können. Dazu gehört auf jeden Fall die Fähigkeit, Datenmodule mit den speziellen S1000D-DTDs bzw. XSDs bearbeiten zu können.

Prinzip 6, Business Rules (BR) und BREX: S1000D ist eine Spezifikation mit sehr vielen Vorgaben, die die unterschiedlichsten Teilbereiche der Dokumentation umfassen, etwa Schreibweisen, Attributverwendung, Datenaustausch- und Layoutvorgaben. Sie ist aber absichtlich sehr anpassungsfähig – es gibt zu den Vorgaben immer viele Optionen und alternative Vorgehensweisen, damit sie in den unterschiedlichsten Projekten eingesetzt werden können.

Mithilfe von Business Rules werden projektspezifische Festlegungen getroffen, also wie die S1000D im konkreten Projekt angewendet werden muss. Aktuell enthält die Spezifikation rund 550 Vorgaben, auf Basis derer alle Projektbeteiligten gemeinsam zu Projektbeginn die Projektregeln festlegen. Ergänzt durch eigene Regeln werden daraus „Style Guide“ und „Guidance Document“ erstellt. Diese Regeln sind in einem Projekt für alle Projektbeteiligten verbindlich. So ist gewährleistet, dass zum Schluss alle Bestandteile zusammenpassen.

Die Bundeswehr hat zum Beispiel einen „National Style Guide“ (NSG) herausgegeben. Er gilt für alle Projekte, je Projekt gibt es weitere einschränkende „Project specific Guidance Documents“ (psGD). Diese Dokumente muss man kennen, damit man in einem Bundeswehr-Projekt arbeiten kann.

Zur Überprüfung der Daten gemäß diesen Business Rules gibt es in der CSDB „BREX“-Dateien, in denen die Regeln maschinenlesbar gespeichert sind und mit Hilfe derer die Einhaltung automatisiert geprüft werden kann.

Prinzip 7, Information Control Number (ICN): S1000D unterstützt bei Illustrationen und Multimedien einen weiten Bereich von vektor- und pixelbasierten Abbildungen, Animationen und interaktiven Darstellungen. Derzeit ist insbesondere das CGM4-Format interessant, weil man damit Callout-Grafiken mit Hotspots und dazugehörige interaktive Verweise erstellen kann. Das CGM4-Format soll in Zukunft durch das SVG-Format ersetzt werden.

Die S1000D legt die Kodierung der Illustrationen, die so genannte ICN, aber auch den Aufbau der Inhalte und die Formate fest. Diese Kapitel aus der S1000D sind neben der Technischen Redaktion für Grafiker und Grafikerinnen wichtig.

Prinzip 8, „Information Sets“ und „Publikationsmodule“ (PM): Für die Publikation von kompletten Handbüchern werden die Datenmodule auf Grundlage von Information Sets zu PM zusammengestellt.

Information Sets sind von den Projektpartnern festgelegte Sammlungen von zusammengehörigen Inhalten, die der Kunde für seine Art der Informationsnutzung wünscht. Für die Inhalte gibt es in S1000D Festlegungen und Vorschläge.

Die Publication Modules nutzen die Festlegungen aus den Information Sets und stellen die Inhalte in der passenden Hierarchie und Reihenfolge zusammen.

Publication Modules sind XML-Dateien, die Verweise auf DMs enthalten. Für diese Module gibt es in der S1000D Festlegungen, zum einen zur Struktur und Benennung und zum anderen zu den möglichen und notwendigen Publikationsarten und deren Inhalten (zum Beispiel Wartungshandbuch oder Ersatzteilkatalog).

Die Formatierung und Ausgabe in eine bestimmte Publikationsart und ein bestimmtes Format (PDF oder Interactive Electronic Technical Publication IETP) erfolgt über eine beliebige Publication Engine.

S1000D in der Bundeswehr

Seit den späten 1990er-Jahren verwendet die Bundeswehr S1000D für alle neuen Projekte und ergänzt die Spezifikation durch eigene verbindliche Vorgaben. Der NSG und die psGDs definieren bundeswehrspezifisch Struktur, Schreibstil, Terminologie und Layout. Es gibt bundeswehrspezifische Prüfprozesse (Qualitätssicherung, technische Validierung und sicherheitsrelevante Freigaben). Wegen der langen Lebenszyklen der Bundeswehr-Systeme müssen DM für die unterschiedlichen Projekte in unterschiedlichen S1000D-Issues geschrieben werden. Aktuell sind dies Issue 2.3 und möglicherweise Issue 4.x, für Alt-Projekte sogar noch Issue 1.x.

IPS-Integration im Detail

S1000D gehört zur S-Series der ASD. Diese Sammlung von Spezifikationen deckt möglichst alle Bereiche des IPS ab. Die einzelnen Spezifikationen und Informationen dazu sind über die Website www.asd-europe.org verfügbar. Dazu gehören:

• S2000M – Materialmanagement
• S3000L – Logistik-Analyse, LSA
• S5000F – Fehlerberichte

Die Verzahnung der Spezifikationen ermöglicht eine einheitliche Datengrundlage für alle Teilbereiche wie Logistik, Training und Betrieb (Abb. 04). Damit können beispielsweise automatisch Ersatzteillisten, die Teil der Publikationen sein sollen, aus Datenbanken generiert werden.

Abb. 04 Beispiel für die Verzahnung der Spezifikationen; damit entsteht eine einheitliche Datengrundlage. Quelle Pia Grubitz

KI und Automatisierung

Der Einsatz von KI bei S1000D befindet sich in einer frühen Phase. Es gibt noch wenige echte Anwendungen, aber viele Themen, die sich in der Entwicklung befinden. KI bietet große Chancen, insbesondere durch die Verzahnung der verschiedenen IPS-Spezifikationen. So könnte zum Beispiel Text für Wartungsanleitungen vorgeschlagen werden, auf der Basis von Predictive-Maintenance-Daten.

Anforderungen an die Redaktion

Die Arbeit mit S1000D ist anspruchsvoll und erfordert umfangreiche Fähigkeiten. Einige sind bereits in der Technischen Redaktion üblich, andere gehen darüber hinaus: Fachliche Kompetenzen

• Ein gutes Verständnis für komplexe technische Systeme
• Kenntnisse von Standards, S1000D und IPS-Grundsätzen
• Die Fähigkeit, technische Abläufe präzise zu beschreiben

Methodische Fähigkeiten

• XML-/XSD-Know-how
• Kenntnisse zu modularen Dokumentationstechniken

Technische Fähigkeiten zu den eingesetzten Werkzeugen

• XML-Editor
• S1000D-CSDB-System
• Illustrationsprogramme
• Terminologie- und Übersetzungstools

Soft Skills

• Teamarbeit mit den vielen parallel arbeitenden Projektbeteiligten (Auftraggeber, Partner, Ingenieure und Ingenieurinnen, Prüfer und Prüferinnen)
• Langfristiges Projekt- und Zeitmanagement

Ein Einstieg in ein S1000D-Projekt bringt oft neue Herausforderungen mit sich:

• Es gibt viel striktere und umfang­reichere Vorgaben durch die Auftraggeber.
• Die Planungs- und Abstimmungs­phasen sind länger.
• Die Anfangsinvestitionen in Tools und Schulungen sind hoch.
• Die Lernkurve ist hoch.

Tipps für den Einstieg

Die komplette Spezifikation der verschiedenen Issues mit Beispieldaten und Zusatzinformationen ist kostenlos unter www.s1000d.org verfügbar. Hilfreich für den Einstieg in das Arbeiten mit S1000D ist das Bike-Data-Set, ein fiktives Fahrradprojekt, das viele S1000D-Dokumenttypen in der Praxis zeigt. Meine Empfehlungen für Einsteiger und Einsteigerinnen:

• Laden Sie die Spezifikation mit allen Zusatzdaten von www.s1000d.org herunter. Falls Sie für deutsche Projekte in der Wehrtechnik arbeiten sollen, laden Sie auf jeden Fall Issue 2.3 und möglicherweise Issue 4.x herunter.
• Auch wenn das umfangreiche Dokument abschreckt: Lesen Sie die Kapitel 1 und 2. Sie sind überschaubar und geben ein solides Grundver­ständnis.
• Halten Sie das Kapitel 8, „Terms and Abbreviation“ bereit. Es hilft Ihnen, die Abkürzungen und Begriffe zu lernen. Ein kurzes deutsches Glossar zu den Begriffen finden Sie auf meiner Website www.grubitz.de.
• Installieren Sie einen XML-Editor mit S1000D-Unterstützung.
• Üben Sie mit den Beispiel-DMs (Bike-Data-Set).
• Nehmen Sie an einer Grundlagen­schulung zu S1000D teil.
• Projektverantwortliche: Nehmen Sie an Schulungen zu S2000M und IPS teil.
• Arbeiten Sie bei Ihren ersten Projekten mit erfahrenen S1000D-Partnern zusammen.
• Kalkulieren Sie großzügig – und sagen Sie das auch Ihrem Vertrieb.

Was am Ende zählt

S1000D ist weit mehr als nur eine Vorgabe für die Erstellung von Handbüchern. Vielmehr handelt es sich um ein Framework für die komplette Organisation, Wiederverwendung und den Austausch von Informationen technischer Inhalte.

S1000D bringt für Technische Redaktionen neue Arbeitsweisen, straffere Strukturen und höhere Anfangsinvestitionen mit sich. S1000D ist aber für einige Auftragsfelder verbindlich und bietet dort langfristig enorme Vorteile. Viele Prinzipien lassen sich in vereinfachter Form auch auf andere Dokumentationsprojekte übertragen. Für mich ist faszinierend, wie umfassend und visionär S1000D von Anfang an konzipiert wurde und bis heute laufend weiterentwickelt wird.