Standardisierung in der Technischen Dokumentation

Alle reden gerade über Konzepte und Standards. Unsere Gesellschaft bekommt einen "neuen" Rahmen, innerhalb dessen Abläufe sicher funktionieren können. In der Produkt- und Systementwicklung gibt es das schon lange. Präzise definierte Standards, an Hand derer Systeme und Produkte entwickelt werden und die Funktionsfähigkeit und Sicherheit gewährleisten. Standards, die Sicherheit geben. Fast wie in einer Gesellschaft...

Was aber ist ein Standard?

Der Duden (Duden, Die deutsche Rechtschreibung, Band 1, 24. Auflage, Dudenverlag Mannheim) beschreibt Standard mit „Maßstab, Richtschnur, Norm; Qualitäts- oder Leistungsniveau“. Eine andere Definition beschreibt Standards als Definitionen und Spezifikationen für Produkte und Prozesse, die wiederholt verwendet werden (European Telecommunication Standards Institute (ETSI)). Ein Beispiel für einen Standard ist die Art, wie ein Kochbuch verfasst wird. Ein Vorwort, ein Inhaltsverzeichnis, die Rezepte mit Titel, Zutaten, Zubereitungsdauer und Schritt-für-Schritt-Beschreibung bis zum finalen Ergebnis und im Anschluss ein Schlagwortverzeichnis. Die Standardisierung bietet Vorteile für beide Seiten: Einerseits weiß der Autor, wie er den Text verfassen muss und andererseits weiß der Leser, wo er schnell welche Information findet.

Und warum brauchen wir Standards in der Technischen Dokumentation?

Auch in der Technischen Dokumentation ist es sinnvoll, Informationen im immer gleichen Schema aufzubereiten. Dies hilft sowohl dem Technischen Redakteur als auch dem Leser. Der Technische Redakteur kann sich an einem Schema orientieren und muss nicht für jede Dokumentation das Rad neu erfinden. Dies spart Zeit und Kosten. Der Leser findet die gewünschte Information schnell, da er den grundsätzlichen Aufbau schon von vielen anderen Gebrauchsanleitungen kennt. Das spart Nerven. Die gesparte Zeit kann für das Erfassen der neuen Informationen genutzt werden.

Für die Technische Dokumentation im zivilen Bereich sind Standards in der Norm IEC/IEEE 82079-1:2019-05; ISO/IEC/IEEE 82079-1:2019-05 (im weiteren ISO 82079 genannt) festgehalten. Dies ist bereits die überarbeitete Version dieser Norm, die erste Version wurde 2013 veröffentlicht. Laut dem Einführungstext in die Version von 2013 beschreibt die Norm Regeln, die für alle Arten von Anleitungen anwendbar sind, von einer Dose Farbe bis hin zu komplexen Industrieanlagen (https://www.beuth.de/de/norm/din-en-82079-1/186186508, Aufruf, 05.03.2020).

In der Luftfahrt und Wehrtechnik sind die Anforderungen in den Spezifikation S1000D „International specification for technical publications utilizing a common source database“ festgehalten. Herausgeber sind die AeroSpace and Defence Industries Association of Europe, Brüssel (ASD), die Aerospace Industries of America (AIA) und die Air Transport Association of America (ATA).

Wieso sollten Standards angewendet werden?

Für den zivilen Bereich schreibt das Produktsicherheitsgesetz (Gesetz über die Bereitstellung von Produkten auf dem Markt, gültig ab 1. Dezember 2011) folgendes vor:

  • Ein Produkt, das unter dieses Gesetz fällt, darf nur auf den Markt gebracht werden, wenn es bei bestimmungsgemäßer Verwendung die Sicherheit und Gesundheit von Personen nicht gefährdet.

  • Falls „bei der Verwendung, Ergänzung oder Instandhaltung eines Produkts bestimmte Regeln zu beachten [sind], um den Schutz von Sicherheit und Gesundheit zu gewährleisten, ist bei der Bereitstellung auf dem Markt hierfür eine Gebrauchsanleitung in deutscher Sprache mitzuliefern, …“.

  • Für die Qualität des Produkts wird genannt, dass davon auszugehen ist, dass ein Produkt, das einer für diesen Bereich gültigen Norm entspricht, den Anforderungen des Produktsicherheitsgesetzes entspricht.

Und genau das ist der wichtige Punkt: Wenn ich meine Gebrauchsanleitung gemäß ISO 82079 verfasse, habe ich schon eine wichtige Anforderung des Produktsicherheitsgesetzes erfüllt.

Wichtiger Hinweis: Je nachdem, welche Art von Produkt ich auf den Markt bringen möchte, müssen weitere Normen und Richtlinien beachtet werden, die sich auf Grund der Eigenschaften des Produkts ergeben. Diese können auch Anforderungen an die Gebrauchsanleitung beinhalten.

In der Luftfahrt und in der Wehrtechnik ist es ganz einfach: Sobald die Dokumentation zu einem Produkt nicht der S1000D entspricht, wird das Produkt nicht in diesem Bereich eingesetzt. Sobald zivile Produkte im militärischen Bereich eingesetzt werden, z.B. ein Infotainmentsystem auf einer Fregatte, muss auch diese Dokumentation der S1000D entsprechen. Entweder der Hersteller des zivilen Produkts passt die Dokumentation entsprechend an oder, im Fall der Fregatte, erledigt das die Werft.

Wie wende ich die ISO 82079 bzw. S1000D an?

Jeder, der sich genauer mit der Norm befassen möchte, sei im zivilen Bereich für die ISO 82079 der Leitfaden der tekom ans Herz gelegt, der im März 2020 erscheint. Der Leitfaden konzentriert sich auf die praktische Umsetzung der Forderungen aus der Norm.

Im Bereich Luftfahrt und Wehrtechnik sind für die S1000D sind alle relevanten Informationen auf http://public.s1000d.org/Pages/Home.aspx zusammengefasst.

Zusammenfassung

Standardisierung macht allen das Leben leichter. Dokumentieren nach Standards scheint zwar zu Beginn aufwendig und komplex zu sein, die Mühe lohnt sich aber schon nach kurzer Zeit. Und diese Erkenntnis ist übertragbar, oder nicht?

Kontakt: 0431 - 888 2111 0

E-Mail: marketing@scope-engineering.de

  • YouTube
  • Twitter
  • XING
  • LinkedIn

© 2020 SCOPE Engineering GmbH

Impressum

Datenschutz

Kontakt

SCOPE Engineering Website       I       test!t     I     t(ea)talk     I     Dezentrales Arbeiten