~2026-11124-47: "Technische Dokumentation" = Eigenname, daher groß

2026-02-19T16:02:07Z

"Technische Dokumentation" = Eigenname, daher groß

Neue Seite

Die [[Spezifikation]] '''S1000D''' ''International specification for technical publications using a common source database'' ist weltweit ein [[XML Schema]] für [[Technische Dokumentation]] in den Bereichen [[Luftfahrt]] und [[Wehrmaterial]]. Herausgeber sind auf europäischer Seite die [[AeroSpace and Defence Industries Association of Europe|ASD]] (AeroSpace and Defence Industries Association of Europe, Brüssel) als Nachfolgeorganisation der [[AeroSpace and Defence Industries Association of Europe#Geschichte|AECMA]], auf US-amerikanischer Seite die AIA (Aerospace Industries of America) und die [[Air Transport Association|ATA]] (Air Transport Association of America, Inc).

Es handelt sich hierbei um eine Spezifikation für das Erstellen [[Technische Dokumentation#Interne und externe Technische Dokumentation|externer Technischer Dokumentation]]. Also zum Erarbeiten von [[Gebrauchsanleitung]]en. S1000D basiert auf internationalen Standards, die vom [[World Wide Web Consortium|W3C]] festgelegt sind. Die [[Extensible Markup Language]] (XML) für Text, das [[Computer Graphics Metafile|Computer-Graphics-Metafile]]-Format (CGM) für 2D-Illustrationen und die [[Virtual Reality Modeling Language]] (VRML) für 3D-Animationen sind Beispiele hierfür. Im Oktober 2006 wurde ein [[Request for Comments|RFC]] für die S1000D gestellt, um einen [[Uniform Resource Name]] zu erhalten.<ref>{{RFC-Internet |Autor=Sean Rushing |RFC=4688 |Titel=A Uniform Resource Name (URN) Namespace for Aerospace and Defence Industries Association of Europe (ASD) Specification 1000D |Datum=2006-10}}</ref>

Die Textanteile der zu erstellenden Dokumentation, sowie alle Grafiken, werden in einer gemeinsamen Quelldatenbank (''common source database)'' gespeichert. Dies ist der „Speicher“ für die Aufbewahrung und Verwaltung von Datenmodulen. Die S1000D definiert jedoch nicht seine Funktionalität oder anderes. Sie besagt lediglich, dass es erforderlich ist, die in einem Projekt erzeugten Datenmodule zu speichern und zu verwalten.<ref>{{Internetquelle |url=https://s1000d.org/?page_id=101 |titel=About S1000D |hrsg=S1000D Council and Steering Committee |datum=2024 |sprache=en-US |abruf=2024-09-09 |kommentar=Absatz: Common Source Data Base (CSDB)}}</ref>

== Verfügbarkeit ==
Die S1000D-Spezifikation in englischer Sprache kann auf der Webseite der S1000D kostenlos heruntergeladen werden.<ref>{{Internetquelle |url=https://users.s1000d.org/Default.aspx |titel=S1000D Downloads |werk=S1000D.org |hrsg=ASD, AIA, A4A |datum=2024 |sprache=en |abruf=2024-08-21}}</ref> Die S1000D ist in 12 Ausgaben verfügbar von Ausgabe 1.7 bis Ausgabe 6.0, mit entsprechenden Zwischenausgaben.

Einige ältere Ausgaben der Spezifikation stehen auch in deutscher Sprache zum Download zur Verfügung.

== Geschichte ==
Vor Ausgabe 2 wurden Aktualisierungen der Spezifikation als Änderungen bezeichnet. Als der Standard Change 9 erreichte, wurde die vorgeschlagene Änderung 10 zu Issue 2.0, wobei frühere Changes als Issue 1.x retro bezeichnet wurden. Issue 1.6 war die erste öffentlich veröffentlichte Version von S1000D und war die erste Ausgabe, die sowohl Operator-Informationen (Crew) als auch Inhalte für Betreuer enthielt.
{| class="wikitable"
|+ Änderungsgeschichte der S1000D
|-
! Ausgabe
! Datum
! Auszeichnungssprache
! Änderung
|-
|1.6
|31. März 1995
|SGML-DTD
''nicht zum Download verfügbar''
|
|-
|1.7
|01. Februar 1998
|SGML-DTD
|1.7.1 vom 2. Juli 1998 (führt die IPRF-DTD ein)
|-
|1.8
|31. Januar 1999
|SGML-DTD
|1.8.1 vom 31. Mai 2000 (diverse DTD-Änderungen)
|-
|1.9
|01. April 2001
|SGML/XML DTD
|
|-
|2.0
|31. Mai 2003
|SGML/XML DTD, XML schema
|Es gibt einen Patch-Ordner, aber keinen offiziellen nummerierten Patch und er enthält nur ein aktualisiertes Datenwörterbuch.
|-
|2.1
|29. Februar 2004
|SGML/XML DTD, XML schema
|
|-
|2.2
|01. Mai 2005
|SGML/XML DTD, XML schema
|2.2.1 vom 01. Mai 2006 (nur XML-Schema)
|-
|2.3
|28. Februar 2007
|SGML/XML DTD, XML schema
|2.3.1 vom 01.02.2009 (diverse Schemaprobleme behoben)
|-
|3.0
|31. Juli 2007
|SGML/XML DTD, XML schema
|3.0.1 vom 01.02.2009 (diverse Schemaprobleme behoben)
|-
|4.0
|01. August 2008
|XML schema
|4.0.1 vom 12. Mai 2009 (umfangreiche Änderungen, aktualisierte BREX)

4.0.2 vom 09.10.2013 (diverse Änderungen, BREX aktualisiert)
|-
|4.1
|31. Dezember 2012
|XML schema
|4.1.A vom 7. Nov. 2014 (korrigiert Fehler im Crew-Schema, der IPD-Fig-Nummer und BREX-Problemen)

4.1.B vom 30. Juni 2017 (aktualisierte BREX-Regeln)

4.1.C vom 12. Mai 2020 (fügt fehlende Warn- und Warn-CIR-InfoCodes wieder hinzu)

4.1.D vom 27. Apr 2023 (.swf Dateien in den Bike-Daten durch .gif ersetzt)
|-
|4.2
|31. Dezember 2016
|XML schema
|4.2.A vom 31. Mai 2019 (nur Spezifikation; keine Schemaänderungen)
|-
|5.0
|28. Juni 2019
|XML schema
|5.0.A vom 01. Nov. 2019 (nur Spezifikation; keine Schemaänderungen)

5.0.B vom 29. September 21 (nur Aktualisierung des Datenwörterbuchs)
|-
|6.0
|01. September 2024
|XML Schema
|Möglichkeiten für Referenzen

Einführung eines neuen SVG-Profils

Einführung eines neuen, modernisierten S1000D-Logos

neue S1000D-Ausgabenummern-Konvention
|}
S1000D stellt keine Software-Tools zur Erstellung oder Verteilung von Inhalten in Übereinstimmung mit dem Standard zur Verfügung und unterstützt diese auch nicht. Es wird nur das reine XML-Schema beschrieben.

== Download Batchinhalt und Dateierläuterung ==
Im Download der gewünschten Version, z. B. Issue 6, der S1000D sind folgende Dateien enthalten: D1000D Functionality Matrix, Issue 6 Example SNS, Issue 6 Front Matter Samples, Issue 6 Unit of Measure, Issue 6 XML Schema Package, Issue 6 BR Template, Issue 6 BRDP Index, Issue 6 Data Dictionary, Issue 6 Default BREX, Issue 6 Bike Sample Data Set, ein Issue 6 Bike Sample Data Set sowie das Schema der Spezifikation Issue 6 selbst.

Die Beschreibung der Spezifikation selbst ist ein PDF mit 3670 Seiten.

Das Bike Sample enthält unter anderem 40 CGM- und 119 HTML-Beispieldateien. Damit ist es möglich das XML-Schema in einen Browser darzustellen, anhand von Beispieldaten, die eine [[Gebrauchsanleitung]] für ein Fahrrad (Bike) erzeugen.<ref>{{Internetquelle |url=https://khzae.net/ietp/view.cgi?publication=S1000DBIKE-B6865-EPWG1-00 |titel=Tools and other resources for the Specification 1000D |werk=khzae.net |hrsg=GitHub: kibook |datum=2019 |sprache=en |abruf=2024-10-10 |kommentar=GPLv3}}</ref> Die Daten des Bike Sample können auch in ein vorhandenes Datenmanagementsystem integriert und anzeigt werden.<ref>{{Internetquelle |url=https://ietdview-online.de/demo/ |titel=ietdview Online Demo |werk=ietdview-online.de |hrsg=Rohde & Schwarz – R&S |datum=2024 |sprache=de |abruf=2024-10-21}}</ref> Die NASA hatte im Jahr 2014 das Projekt „Technical Data Interoperability (TDI) Pathfinder Via Emerging Standards“, das für die NASA IT Labs durchgeführt und vom NASA Office of Chief Information Officer (OCIO) unterstützt wurde. Dieses Projekt bewertete und testete eine Reihe von Industriestandards für einen Konzeptnachweis. Hier wurde das Bike Sample für eine Reihe von Tests genutzt, um die Daten nach verschiedenen Standards zu konvertieren.<ref>{{Internetquelle |url=https://ntrs.nasa.gov/api/citations/20160000235/downloads/20160000235.pdf |titel=White Paper for Technical Data Interoperability (TDI) Pathfinder Via Emerging Standards Proof of Concept Phase |hrsg=NASA |datum=2014-12-17 |seiten=Seite 8; Test Data Sets |format=PDF |sprache=en |abruf=2024-10-17}}</ref>

Das Datenmodul der Regelvorlage (Business Rules (BR)) enthält alle Regeln, die für die aktuelle Ausgabe der Spezifikation gelten und durch diese definiert sind. Die Spezifikation muss durch die sogenannten Business Rules auf ein spezifisches Projekt angepasst (tailored) werden. Regeln (BR) sind der Schlüssel zum Erfolg eines jeden S1000D-Projekts. Die Regeln, die für S1000D-Publikationen gelten, sind mehrschichtig. Jede Schicht erbt und erweitert die Regeln der vorherigen Schicht, ähnlich dem [[Darwin Information Typing Architecture|DITA]] [[Dokumentenformat]]. Sie treffen im Wesentlichen eine Reihe von möglichen Entscheidungen im Voraus. Ziel ist es, dass alle (oder fast alle) Entscheidungen zu dem Zeitpunkt getroffen sind, an dem das eigentliche Schreiben der Anleitung beginnt, so dass jeder nach denselben Regeln schreibt. Aus diesem Grund wird in der Spezifikation so viel über sie gesprochen, insbesondere über die Business Rule Decision Points (BRDP) und Business Rules Exchange (BREX). Hier wird festgelegt, was in der zu fertigenden Anleitung beschrieben wird und wie es in der Anleitung dargestellt werden soll. Diese Festlegungen werden in einem Guidence Document (GD) festgehalten.

Seit Anfang 2025 steht ein Datenwörterbuch (Data Dictionary) für die Versionen 4.0, 4.1, 4.2, 5.0 und 6 zur Verfügung. Die Data Dictionaries sind Webseiten zur Anzeige der Definitionen und technischen Details für alle in den S1000D-Schemata verwendeten Elemente und Attribute sowie Erklärungen dazu.<ref>{{Internetquelle |url=https://s1000d.org/?page_id=1003 |titel=S1000D Data Dictionaries – S1000D |sprache=en-US |abruf=2025-01-17}}</ref> Die Data Dictionaries sind nun ebenfalls Bestandteil der jeweiligen Batches beim Download.

== Common Source Database ==
Die Common Source Database ist das [[Repository]] aller Dokumente (XML-Datenmodule, eingebundene PDF- und XML-Dateien), Grafiken und eventuell 3D-Animationen, die für die Publikation der Gebrauchsanleitung benötigt werden. Je nach Umfang der Anleitung kann die Common Source Database als ein Ordnersystem angelegt werden oder als [[Dokumentenserver]] in welchem die Version jedes einzelnen Dokumentes oder Grafik nachverfolgt werden kann.

== Systematik ==
Die S1000D gliedert die Dokumentation von Systemen entsprechend ihrer Systemarchitektur in Subsysteme und Komponenten unter Verwendung eines sog. „Standard Numbering System“ (SNS). Eine Dokumentation nach S1000D besteht aus Daten-Modulen (data modules), die unter Verwendung der Markup-Sprache in XML erzeugt und redundanzfrei in der CSDB gespeichert werden. Jedem gemäß Geräteaufbruch als Subsystem oder Komponente definierten Teil des zu dokumentierenden Systems sind eindeutig definierte Daten-Module zugeordnet.<ref>{{Internetquelle |url=https://www.bundeswehr.de/de/organisation/unterstuetzungsbereich/logistik/logistikkommando-der-bundeswehr-in-erfurt/einheitliche-materialkatalogisierung-im-logkdobw/s-1000d-international-en-specification-en-for-en-technical-en-publications-en-5707894 |titel=S 1000D International specification for technical publications |sprache=de |abruf=2025-05-27}}</ref>
[[Datei:S1000D-DMC.jpg|mini|Systematik des Datenmodul-Codes]]
Jedem Daten-Modul ist ein Data-Module-Code (DMC) zugeordnet, der den Bearbeitungsstand des Daten-Moduls und die Einbindung des Daten-Moduls in die logische Struktur des zu schaffenden Dokuments ([[Gebrauchsanleitung|Anleitung]]) beschreibt.

Der Data-Module-Code ist eine 17- bis 37-stellige alphanumerische Kodierung und ist Bestandteil der [[Metadaten|Meta-Daten]] jedes Daten-Moduls.

Die ersten Stellen des DMC (von links gesehen) geben das Projekt wieder (z. B. [[Eurofighter Jagdflugzeug|Eurofighter]]) und werden bei der [[NAMSA]] beantragt. Genannt wird dieser Anteil des DMC: Model Identifications Code (MIC).<ref>{{Internetquelle |url=https://markupuk.org/2018/webhelp/ar02s03s01s02.html |titel=Model Identification Code |abruf=2025-05-27}}</ref>

== Software ==
In der Praxis sind einzelne S1000D-Komponenten (Datenmodule, Abbildungen etc.) als Rohdaten nur schwer lesbar, da sie als Austauschformat gedacht sind. Deshalb verwenden S1000D-Redakteure und -Nutzer zur Erstellung, Bearbeitung und Anzeige von S1000D-Inhalten verschiedene Software. Einige der meistgenutzten Anwendungen werden hier aufgelistet:

=== Autorensoftware ===
* [https://www.oxygenxml.com/xml_editor.html Oxygen XML Editor.] oxygenxml.com; with [https://github.com/oxygenxml/S1000D S1000D Framework] github.com
* [https://www.onestrand.com/s1000d-software-suite/s1000d-authoring/ R4i Writer.] onestrand.com
* [https://www.antennahouse.com/formatter/ Antenna House Formatter.] antennahouse.com
* [https://xmetal.com/ XMetaL]
* [https://www.stender-gmbh.com/software-entwicklung/ S-Tools.] stender-gmbh.com

=== Anzeige-Software ===
* [http://www.informatikplm.com/static/upload/files/ArbortextIETP_Viewer3.pdf Arbortext<sup>®</sup> IETP Viewer for S1000D.] informatikplm.com
* [https://libroplanta.com/en/S1000D-IETP-VIEWER Libroplanta S1000D IETD Viewer.] libroplanta.com
* [https://ietdview-online.de/ R&S<sup>®</sup> IETDView.] ietdview-online.de
* [https://www.onestrand.com/s1000d-software-suite/s1000d-viewer/ R4i Viewer.] onestrand.com
* [https://www.sdl.com/download/livecontent-s1000d-2017/126445/ SDL LiveContent S1000D.] sdl.com

== Deutschland ==
Da S1000D eine internationale Spezifikation ist, hat die Bundeswehr gemeinsam mit der Industrie den '''Arbeitskreis Beschreibende Technische Dokumentation''' (AK BTD) gebildet, um nationale Bedürfnisse und Interessen zu erkennen und diese an das internationale S1000D-Gremium in Form von Änderungsanträgen weiterzuleiten. Ziel ist die Weiterentwicklung sowie Auslegung der Spezifikation zugunsten nationaler Anforderungen und Anwendungen.<ref>{{Internetquelle |url=https://akbtd.de/home/ |titel=Willkommen auf der Internetpräsenz des AK BTD |werk=Wayback Machine |hrsg=Logistikkommando der Bundeswehr,Abteilung Planung III 2 – Standards und Spezifikationen, Arbeitskreis Beschreibende Technische Dokumentation |datum=2021-12-16 |sprache=de |archiv-url=https://web.archive.org/web/20161107171412/https://www.akbtd.de/index.php |abruf=2024-08-21 |kommentar=Originalseite nicht mehr erreichbar}}</ref>

== Siehe auch ==
* [[ASD-STAN|AECMA]]
* [[Standard Generalized Markup Language|SGML]] bzw. [[Extensible Markup Language|XML]]
* [[Computer Graphics Metafile]]
* [[Virtual Reality Modeling Language|VRML]]

== Weblinks ==
* [https://www.asd-europe.org/ ASD]
* [http://www.s1000d.org Technical Publications Specification Maintenance Group (TPSMG)]
* [https://s1000d.org/ Website der S1000D]

== Einzelnachweise ==
<references />

[[Kategorie:Technische Dokumentation]]
[[Kategorie:Luftfahrttechnik]]
[[Kategorie:Militärische Informations- und Kommunikationstechnologie]]

S1000D - Versionsgeschichte

~2026-11124-47: "Technische Dokumentation" = Eigenname, daher groß