ASD S1000D – mit Methode zum Ziel
Einleitung – Introduction to the specification
Wie bei jedem Projekt gilt: Je besser die Hausaufgaben im Vorfeld erledigt werden, desto nervensparender wird das Ziel erreicht.
Die S1000D führt durch Rahmenbedingungen und Details wie beispielsweise Produktdefinition, Wartungsphilosophie, einzuhaltende Sicherheitsstufen, Datenerstellung, Datenausgabe und Bereitstellung der Publikation.
Dabei sind zahlreiche Fragestellungen zu klären: Welche Detailtiefe wähle ich für meine Datenmodule? Wie baue ich die Publikation(en) auf? Wie benenne ich Dateien und Grafiken, damit eine eindeutige Zuordenbarkeit gewährleistet wird? Welche Schreibregeln brauchen wir im Team? Wie bilde ich den zentralen Punkt der Materialerhaltung ab?
Dokumentationsprozess – Documentation Process
Wo Spielraum besteht, fordert die S1000D auf, eigene Regeln (Business Rules) zu definieren. Am Ende steht eine standardisierte und dennoch maßgeschneiderte Lösung.
Verbindliche Business Rules werden für die automatisierte Qualitätssicherung in einem BREX-Datenmodul festgehalten und gegengeprüft.
Informationserstellung – Information Generation
S1000D heißt Unterstützung auf ganzer Linie: Datenmodellierung, Qualitätssicherung, Änderungsmanagement, Versionierung und Schreibregeln für konsistente Inhalte.
Datenmodule (DM) sind unabhängige Informationseinheiten aus Texten und Illustrationen, die per Data Module Codes (DMC) identifizierbar sind. Es gibt unterschiedliche Typen von Datenmodulen, die je nach Informationsgehalt verwendet werden (Description, Crew, Procedural, IPD).
Alle Datenmodule folgen einer Grundstruktur, die aus einem Verwaltungsbereich (IdentAndStatus Section) und einem (vor-)strukturierten Inhaltsbereich (ContentSection) besteht.
Texte, die in mehreren Datenmodulen oder Publikationen Anwendung finden, können über sogenannte CIR-Datenmodulen als Single Source-Quelle aufgebaut werden.
Information Sets unterstützen den Erstellungsprozess einer Publikation. Ein oder mehrere Sets bilden eine Publikation. Aufbau und Gliederung bildet die LOAP ab (List of Applicable Publications).
Informationsmanagement – Information Management
Nummern und Listen spielen in der S1000D eine gewichtige Rolle. Hierbei geht es um Identifizierung (Adressierung), Speicherung und Verwaltung der Datenmodule und Publikationen.
Bei S1000D-Projekten gibt es eindeutige Anforderungen an Data Module Codes (DMC) (Datenmodule), Information Control Numbers (ICN) (Illustrationen) sowie Publication Module Codes (PMC) (Publikationen).
Das zentrale Element für Planung, Management und Verwaltung ist die CSDB Status List, die alle Datenmodule und Zusatzdateien in allen Ausgabeständen enthält.
Die LOAP zeigt den Aufbau und die Gliederung der technischen Dokumentation gemäß den Gruppierungen (Information Sets) und Publikationen.
Auf der Ausgabeebene (Publikation) ist die Data Module Requirement List (DMRL) maßgeblich. Sie filtert die notwendigen Datenmodule für die Publikation(en) aus der CSDB.
Fazit
Zugegeben: Die S1000D ist auf den ersten (und auch zweiten) Blick ein mächtiges Tool. Sorgfalt ist bei der Dokumentation nach S1000D auf jeden Fall geboten.
Aber im Grunde genommen nimmt der Standard enorm viel Kopfarbeit für das Verfassen eines brauchbaren Redaktionshandbuches vorweg.
Vom Dokumentationsprozess über das Informationsmanagement und Informationsgenerierung bis zur Publikation sind alle Prozesse und einzelne Arbeitsschritte bedacht.
Mit seiner generellen Forderung nach Austauschbarkeit der Informationen kann der Standard als Vorbild bzw. Vorläufer für das Metadatenmodell iiRDS gesehen werden, das im Hinblick auf Industrie 4.0 in aller Munde ist.
text-it bietet Ihnen folgende Dienstleistungen rund um die S1000D
- Beratung und Schulung zu S1000D
- Konzeption der S1000D-Dokumentation
- Erstellung Redaktionsleitfaden
- IETP-Publikation (XML-Datenmodule, PDF-Publikation, IETP-Publikation (HTML))
PS: Aufgrund der sehr beliebten und viel genutzten Abkürzungen empfehlen wir eine Terminologie mitzuführen.
Zu den wichtigsten Abkürzungen der S1000D.
Stand: 2022
