Kurz gesagt: S1000D ist eine internationale Spezifikation, mit der technische Publikationen wie Wartungs-, Bedien- und Teilehandbücher aus kleinen, wiederverwendbaren Einheiten von XML-Inhalten erstellt werden, den sogenannten Datenmodulen. Jedes Datenmodul hat einen eindeutigen Datenmodulcode und liegt in einer gemeinsamen Quelldatenbank (CSDB), aus der Publikationen für Druck, PDF oder interaktive Viewer zusammengestellt werden. Entstanden in der europäischen militärischen Luftfahrt, ist S1000D heute in vielen Luftfahrt- und Verteidigungsprogrammen vorgeschrieben und wird für Land- und Seesysteme sowie andere komplexe Ausrüstung genutzt.
Woher S1000D kommt
S1000D wurde in den 1980er-Jahren vom europäischen Luftfahrtindustrieverband, heute ASD, ins Leben gerufen, um die Dokumentation von Militärflugzeugen zu verwalten. Die erste Issue erschien 1989. Heute pflegt das S1000D Steering Committee die Spezifikation. Zu seinen Mitgliedern gehören ASD, die Aerospace Industries Association (AIA) in den USA und das ATA e-Business Program von Airlines for America, neben nationalen Vertretern aus Verteidigung und Industrie.
Die Spezifikation erscheint in nummerierten Issues und kann kostenlos von s1000d.org heruntergeladen werden. Issue 7, die neueste, erschien 2026, nach Issue 6 im Jahr 2024 und Issue 5.0 im Jahr 2019. Ein Programm bleibt normalerweise bei der Issue, die sein Vertrag nennt. Deshalb sind Daten nach Issue 4.x in langlaufenden Programmen noch verbreitet.
Datenmodule: einmal schreiben, vielfach veröffentlichen
Ein Datenmodul ist die kleinste in sich geschlossene Informationseinheit in S1000D: die Beschreibung einer Hydraulikpumpe, das Verfahren zu ihrem Ausbau, die Liste ihrer Teile. Es wird einmal geschrieben und in jeder Publikation wiederverwendet, die es braucht. So wird eine Änderung an einer Stelle vorgenommen.
S1000D definiert für jede Informationsart ein Schema. Die häufigsten sind:
- Beschreibend: was ein System ist und wie es funktioniert.
- Prozedural: die Schritte einer Aufgabe, etwa einer Inspektion, eines Ausbaus oder eines Einbaus.
- Fehlersuche: wie die Ursache eines Fehlers gefunden wird.
- Illustrierte Teiledaten: Explosionsdarstellungen und Teilelisten zum Identifizieren und Bestellen von Teilen, die S1000D-Form eines illustrierten Ersatzteilkatalogs.
- Wartungsplanung: was wann zu prüfen oder zu tauschen ist.
- Besatzung und Bediener: Checklisten und Bedieninformationen.
Ein Publikationsmodul legt dann fest, aus welchen Datenmodulen eine Publikation besteht und in welcher Reihenfolge.
Wie ein Datenmodulcode funktioniert
Jedes Datenmodul wird durch einen Datenmodulcode (DMC) identifiziert, der das Produkt, den Produktteil und die Informationsart des Moduls beschreibt. Ein Beispielcode zur Veranschaulichung für das Ausbauverfahren einer Pumpe:
DMC-CP200-A-29-10-00-00A-520A-A
| Segment | Im Beispiel | Bedeutung |
|---|---|---|
| Model Identification Code (Modellkennung) | CP200 | Das Produkt oder Projekt. |
| System Difference Code (Systemvariante) | A | Welche Variante des Systems. |
| Standard Numbering System (Standardnummerierung) | 29-10-00 | System, Teilsystem und Einheit. Bei Luftfahrzeugen folgt sie oft der ATA-Kapitelnummerierung. |
| Disassembly Code und Variante (Zerlegungsstufe) | 00A | Die Zerlegungsstufe der Einheit. |
| Information Code und Variante (Informationsart) | 520A | Die Informationsart: 520 ist ein Ausbauverfahren, 720 ein Einbau, 040 eine Beschreibung und 941 illustrierte Teiledaten. |
| Item Location Code (Arbeitsort) | A | Wo die Arbeit ausgeführt wird: A bedeutet, dass die Einheit im Produkt eingebaut ist. |
CSDB, BREX, Anwendbarkeit und IETP
- CSDB (Common Source Database): das Repository, das jedes Datenmodul, jede Abbildung und jedes Publikationsmodul mit Status, Issue und Historie enthält.
- BREX (Business Rules Exchange): ein Datenmodul, das die Geschäftsregeln eines Projekts festhält, etwa welche Elemente und Werte erlaubt sind, in einer Form, die Tools automatisch prüfen können.
- Anwendbarkeit: Bedingungen, die Inhalte für eine bestimmte Konfiguration, Seriennummer oder Modifikation ein- oder ausblenden.
- IETP (interaktive elektronische technische Publikation): die Ausgabe für interaktive Viewer, neben seitenbasiertem PDF.
Wann sich S1000D lohnt
S1000D lohnt sich, wenn ein Vertrag es verlangt, wenn viele Produktvarianten dieselben Inhalte teilen und wenn die Dokumentation so lange leben muss wie die Ausrüstung, oft jahrzehntelang. Der Aufwand ist nicht zu unterschätzen: Geschäftsregeln festlegen, eine CSDB betreiben, Autoren schulen und bestehende Handbücher konvertieren.
Mit dieser Konvertierung beginnen die meisten Zulieferer. Ihre Handbücher liegen in Word oder PDF vor, mit Beschreibungen und Verfahren gemischt auf derselben Seite. Diese Inhalte in Datenmodule aufzuteilen, zu codieren und gegen den BREX des Projekts zu prüfen, kostet die meisten Expertenstunden.
Mit TwinWorks von PDF-Handbüchern zu S1000D-Datenmodulen
TwinWorks importiert bestehende PDF- oder Word-Handbücher, entwirft modulare Inhalte mit Verknüpfung zu ihren Quellen und exportiert beschreibende und prozedurale S1000D-Datenmodule, sobald Ihre Fachleute sie freigegeben haben. TwinWorks beansprucht keine S1000D- oder BREX-Konformität: Validieren Sie die exportierten Module mit Ihren eigenen Tools gegen den BREX Ihres Projekts. So funktioniert der Export von S1000D-Datenmodulen.
Sie wählen zwischen einer vollständigen S1000D-Suite und einem schlankeren Weg? Lesen Sie TwinWorks vs PTC Arbortext und TwinWorks vs Cortona3D RapidAuthor.
FAQ
Ist S1000D kostenlos?
Ja. Die Spezifikation kann kostenlos von s1000d.org heruntergeladen werden. Die Software zum Erstellen, Verwalten und Veröffentlichen von S1000D-Inhalten wird separat verkauft.
Was ist der Unterschied zwischen S1000D und DITA?
Beide sind XML-Standards für modulare Inhalte. DITA ist eine allgemeine Topic-Architektur, die verbreitet für Software- und Produktdokumentation genutzt wird. S1000D ist eine Spezifikation für die technischen Publikationen komplexer Ausrüstung, mit integrierten Datenmodulcodes, Anwendbarkeit, einer gemeinsamen Quelldatenbank und projektspezifischen Geschäftsregeln. Verträge in Luftfahrt und Verteidigung nennen meist S1000D.
Was ist ein BREX in S1000D?
Ein BREX-Datenmodul (Business Rules Exchange) hält die S1000D-Geschäftsregeln eines Projekts in maschinenlesbarer Form fest, sodass Datenmodule vor der Lieferung automatisch dagegen geprüft werden können.
Welche S1000D-Issue sollte ich verwenden?
Die Issue, die Ihr Vertrag oder Ihr Kunde nennt. Programme bleiben meist bei der Issue, mit der sie begonnen haben, während neue Programme oft eine aktuelle Issue wählen. Klären Sie das mit Ihrem Kunden, bevor Sie Inhalte konvertieren.
Exportiert TwinWorks S1000D-Datenmodule?
Ja. TwinWorks exportiert beschreibende und prozedurale S1000D-Datenmodule aus Inhalten, die Ihre Fachleute freigegeben haben. TwinWorks beansprucht keine S1000D- oder BREX-Konformität. Validieren Sie die exportierten Module daher mit Ihren eigenen Tools gegen den BREX Ihres Projekts.
Verwandte Begriffe und Seiten
Machen Sie aus einem Handbuchkapitel Datenmodule
Importieren Sie ein PDF- oder Word-Handbuch und sehen Sie den modularen Entwurf, den TwinWorks für Ihre Fachleute zum Prüfen, Freigeben und Exportieren vorbereitet.