S1000D™

Die S1000D™ ist eine Richtlinie zur standardisierten Dokumentationserstellung und wurde von der AECMA (The European Association of Aerospace Industries) entwickelt. Die Weiterentwicklung unterliegt derzeit einer Arbeitsgruppe der ASD (AeroSpace and Defence Industries Association of Europe), der AIA (Aerospace Industries Association) und der ATA (Air Transport Association).

Im Rahmen gemeinsamer, d. h. länder- und organisationsübergreifender Projekte gewährleistet die S1000D™ durch diese Festlegungen, dass der Informationsaustausch untereinander ermöglicht wird und einheitliche Dokumentationen erstellt werden. Diese zunächst für die Luftfahrt erstellte Spezifikation wurde mittlerweile auch für die Belange anderer Geräte und Systeme angepasst.

Die Bundeswehr erkannte die Vorteile für ihre Technische Dokumentation und fordert seitdem die Umsetzung dieser Richtlinie.

Aufgrund der großen internationalen Akzeptanz kann die S1000D™ als „der“ internationale Standard für Technische Publikationen bezeichnet werden. Nähere Informationen finden Sie auf der Homepage der S1000D™:

www.s1000d.de

CONDOK hat sich dazu entschlossen, S1000D™-Dokumentation mit GRIPS zu erstellen.

Die Geschichte der S1000D™ und ihre Aufgaben

Die S1000D™ wurde ursprünglich durch die AECMA (Association Européenne des Constructeurs de Matériel Aérospatial) erarbeitet. Die AECMA war ein Zusammenschluss mehrerer europäischer Luftfahrtunternehmen, dem sich nach und nach viele Organisationen sowie nationale Ämter und Behörden anschlossen (z. B. das Bundesministerium der Verteidigung).

Der Zuwachs an internationalen gemeinschaftlichen Projekten in den siebziger und achtziger Jahren forderte die Vereinheitlichung der Dokumentationsmethoden. Verschiedene Gremien und Arbeitsgruppen der AECMA erarbeiteten die AECMA SPEC 1000D und entwickelten sie ständig weiter.

ASD

Heute ist die AECMA in einer neuen Organisation, der ASD, aufgegangen. Die ASD entstand durch den Zusammenschluss der AECMA, EDIG (European Defence Industries Group) und EUROSPACE (Association of the European Space Industry). Für die Weiterentwicklung der Richtlinie von ASD und AIA ist die Arbeitsgruppe TPSMG (Technical Publications Specification Maintenance Group) verantwortlich. Diente die S1000D™ zunächst ausschließlich der Luftfahrtindustrie, so werden ihre Vorgaben inzwischen auch in angepasster Form in anderen Technologiebereichen, sowohl in militärischen als auch in zivilen Projekten, angewendet.

Festlegungen durch die S1000D™

Die Richtlinie enthält allgemeine und spezielle Regeln zur Erstellung technischer Vorschriften:

  • Schreibregeln bei englischer Dokumentation (Simplified Technical English), Illustrationsregeln, Änderungsdienst, Qualitätssicherung usw.
  • Verwendung von bestimmten Auszeichnungssprachen und Datenformaten wie z. B. SGML und CGM
  • Unterschiedliche DTD-Typen für verschiedene Informationstypen mit z. B. beschreibendem oder prozeduralem Charakter
  • Standardnummerierungssystem zur Kodierung von Geräten und Prozeduren
  • Modularisierung der Informationen in Datenmodulen (DM), alphanumerische Kodierung der Datenmodule über den Data Module Code (DMC)
  • Alphanumerische Kodierung von Abbildungen über die Illustration Control Number (ICN)
  • Anwendung einer Common Source Database (CSDB) als zentrales Speicher- und Verwaltungsmedium der Informationsbausteine
  • Datenaustausch zwischen den am Projekt beteiligten Institutionen
  • Festlegung von diversen Publikationstypen für Beschreibung, Wartung, Fehlersuche usw.
  • Festlegung von verschiedenen Ausgabeformaten
Simplified Technical English

Bei Simplified Technical English (STE) handelt es sich um eine kontrollierte Sprache, die von der AECMA (heute ASD) entwickelt wurde. Durch einen begrenzten Wortbestand und strenge Schreibregeln sorgt diese Sprache für Eindeutigkeit und Verständlichkeit.

Ursprünglich entwickelt für die Erstellung von Wartungshandbüchern in der Luftfahrtindustrie, wird STE auch immer mehr in anderen Technologiebereichen eingesetzt.

CONDOK erstellt Ihre Dokumentation auf Wunsch natürlich auch in Simplified Technical English. Einige zentrale Merkmale von STE sind:

Festgelegtes Vokabular von Benennungen mit nur einer Bedeutung

  • Bsp.: „about“ darf nur mit der Bedeutung „über“ (about a topic) und nicht im Sinne von „ungefähr“ verwendet werden

Reduzierung der zugelassenen grammatischen Kategorien und Zeitformen

  • Bsp.: „decrease“ darf nur als Verb, nicht als Nomen verwendet werden
  • Bsp.: für „get“ sind nur zugelassen: get, gets, got (kein „getting“ oder das amerikanische „gotten“)

Einfache und kurze Satzkonstruktionen

  • Bsp.: nur 20 Wörter pro Satz in einer Anweisung
  • Bsp.: kein Passiv in Anweisungen, Reduzierung von Passiv in beschreibenden Texten
IETP-X

IETP-X bezeichnet die XML-basierte Interaktive Elektronische Technische Dokumentation bzw. Publikation. Bei der Bundeswehr steht der Begriff IETP-X für die Browser-Komponente zur Anzeige von S1000D™-Datenmodulen – kurz IETP-X-Bw – und basiert auf der Organisatorisch Technischen Forderung OTF 1261.

CONDOK besitzt umfangreiche Erfahrungen und Kenntnisse in der Erstellung von S1000D™-Publikationen für alle Waffengattungen der Bundeswehr. In einer Vielzahl von Projekten für z. B. gepanzerte Fahrzeuge, Fregatten und U-Boote sowie für Fernmelde- und EloKa-Systeme haben wir Datenmodule erstellt und geliefert.

Wir sind vertraut mit den gültigen nationalen Richtlinien wie den „Durchführungsbestimmungen der S2000M“ und dem „National Style Guide“ (NSG). Zu unserem Leistungsspektrum im Bereich der IETD gehört das Erstellen von BREX-Dateien, Business Rules, Guidance-Dokumenten, Redaktionsleitfäden, IETD-Leistungsbeschreibungen sowie Schulungen in diesen Bereichen (S1000D™, S2000M).

S1000D™ – Schulungen

CONDOK richtet die Schulungen zielgruppengerecht auf Ihre Belange aus:

S1000D™

Die S1000D™ ist eine sehr umfangreiche Spezifikation, die sich mit unterschiedlichsten Bereichen einer Technischen Dokumentation beschäftigt. Dementsprechend ist es hier wenig sinnvoll, alle Bereiche bis in die Details zu kennen, wenn man für seinen Bereich nur einen Teil davon benötigt. So haben Grafiker einen anderen Schulungsbedarf als Redakteure oder Projektleiter, die projektspezifische Leitfäden schreiben bzw. die Konsequenzen für eventuelle Mehrkosten bewerten müssen.

Durch die rechtzeitige Schulung aller Beteiligten können unnötige Verzögerungen und Kosten im Projekt verhindert werden.

Business Rules

Durch die S1000D™ werden bei Weitem nicht alle Festlegungen getroffen, die für die einheitliche Erstellung von Daten nötig sind. Aus diesem Grund gibt es für das S1000D™-System der Bundeswehr (IETP-X Bw) den sogenannten National Style Guide (NSG). Hier werden Vorgaben gemacht, um sicherzustellen, dass die Daten einheitlich erstellt werden und sich gut im System darstellen lassen.

Auch diese weitere Festlegung ist nicht ausreichend, um mit einem Projekt zu beginnen. Ein weiterer projektspezifischer Leitfaden (Guidance Document [GD], Anwenderleitfaden [AWL], Redaktionsleitfaden [RLF] ...) muss festlegen, wie die Daten innerhalb des Projektes erstellt werden.

Wir bieten diese Schulungen und Workshops nur individuell auf gesonderte Anfrage an. Dabei sprechen wir gerne die für Sie geltenden Leitfäden mit Ihnen durch und weisen Sie auf die Besonderheiten hin: Kontakt

Bitte haben Sie Verständnis dafür, dass wir diese Leistungen nicht für Dienstleistungsunternehmen anbieten.