kothes • Smart Blog | kothes

Die Doku-Norm IEC/IEEE 82079-1:2019

Geschrieben von Jörg Sannemann | 8. Juli 2019 04:00:00 Z

Seit knapp einem Monat liegt nun die finale Version der IEC/IEEE 82079-1, Edition 2 in englischer und französischer Sprache vor. Ich habe in den letzten Tagen die Seminarunterlagen für ein Seminar der kothes academy überarbeitet und habe dies zum Anlass genommen, mal etwas genauer zu lesen und gleichzeitig einen Schritt zurück zu machen. Eine Frage hat mich bei der Lektüre besonders interessiert:

Bietet die IEC/IEEE 82079-1:2019 einen Mehrwert für den Redaktionsalltag?

Vorab: Die Norm erfindet das Rad nicht gänzlich neu. Es kann aber deutlich besser rollen, wenn die Normenforderungen im Arbeitsalltag umgesetzt werden. Die Technische Redaktion kann hierzu einen kleinen – aber dennoch wichtigen – Beitrag leisten.

Die Norm betrachtet neben den Informationsprodukten auch die Prozesse im Informationsmanagement und die Akteure in der Technischen Redaktion. Die Tatsache, dass ein Informationsprodukt als Ergebnis eines zielgerichteten und geplanten Prozesses dargestellt wird, verdeutlicht einen Sachverhalt. Dieser Sachverhalt ist nach meiner Erfahrung vielen Unternehmen möglicherweise nicht vollumfänglich bewusst: Das fertige Informationsprodukt ist nur die sprichwörtliche Spitze des Eisbergs.

Wenn dieses Informationsprodukt seine Aufgabe, auf die ich später noch eingehen möchte, erfüllen soll, müssen Dokumentationsprozesse mit vielen weiteren Prozessen und Verantwortungsbereichen in einem Unternehmen verflochten werden, was die Norm recht deutlich anspricht. Dokumentation muss Teil des Produktentwicklungsprozesses werden. Neben technischem Fachwissen müssen andere Unternehmensbereiche auch Inhalte wie z. B. Konstruktionszeichnungen oder technische Daten, Wissen um Märkte oder die Zielgruppen und, in komplexeren Konstellationen, teilweise auch juristische Beratung beisteuern. Allein das technische Fachwissen muss dabei vor, manchmal während und auch nach der Inhaltserstellung verfügbar sein. Denn die Redaktion braucht eingangs Informationen, hat während des Schreibprozesses Fragen und braucht eine Rückmeldung, ob das Informationsprodukt die technischen Sachverhalte korrekt abbildet. Bei Änderungen am Produkt müssen je nach Änderung wieder sämtliche Ansprechpartner zur Verfügung stehen.

Arbeitsteilung in der Technischen Redaktion

Auch wird klar, dass eine Professionalisierung in der Technischen Redaktion unerlässlich ist. Die Norm listet die Vielzahl von Anforderungen an die Technische Redaktion auf und unterstreicht, dass auch in der Technischen Redaktion unterschiedliche Aufgaben und Verantwortungen verteilt werden müssen. Was in anderen Unternehmensbereichen selbstverständlich ist, wird in der Technischen Redaktion bisweilen hinterfragt: Unterschiedliche Anforderungen erfordern unterschiedliche Qualifikationen. Vermutlich werden Technische Zeichner in einem Maschinenbauunternehmen für ein Bauteil nicht die Werkstoffe auswählen oder dessen Dimensionierung festlegen. „Einfache“ Ingenieure in der Konstruktionsabteilung werden selten die strategische Ausrichtung eines Produktbaukastens festlegen. Natürlich können die genannten Aufgaben in kleinen Unternehmen teilweise auch von einer einzelnen Person bewältigt werden. Dies kann auch in der Technischen Redaktion der Fall sein, was die Norm ausdrücklich erwähnt. Mein persönlicher Eindruck ist, dass die Eine-Frau-Lösung oder Ein-Mann-Lösung deutlich häufiger gewählt wird, als eigentlich angebracht wäre.

Im Kontext der Aufgabenverteilung wird von der Norm sinngemäß eine Angemessenheit der Kapazitäten, Fähigkeiten und Kenntnisse von zugeteiltem Personal zu vorhandenen Aufgaben gefordert. Für viele mittelständische Unternehmen werden diese Forderungen eine große Herausforderung mit sich bringen. Technische Redaktionen füllen oft weder die Ebene der (strategischen) Planung und Konzeptionierung noch die Ebene der eigentlichen Inhaltserstellung ausreichend aus. Das kann durch mangelnde Fachkenntnisse oder schlichtweg durch Zeit- und Personalmangel begründet sein.

Nehmen wir mal an, ein Unternehmen entscheidet sich, seine Prozesse dokumentationsfreundlich anzupassen, ausreichende Kapazitäten zu stellen und so Rahmenbedingungen zu schaffen, um Informationsprodukte zu konzipieren und mit Inhalten zu füllen. Kann die Norm dabei helfen, zielgerichtet gute und sinnvolle Informationsprodukte zu schaffen? Ich finde: ja, das kann sie.

Zielgruppe, Nutzungssituation und konkrete Umsetzung

Ein unglaublich wichtiger Schritt für die Schöpfer von Informationsprodukten und insbesondere von Nutzungsinformationen ist die Erkenntnis, dass die Informationen tatsächlichen Menschen bei ihren Aufgaben helfen sollen. Die Norm fördert diese Erkenntnis, indem sie verdeutlicht, dass neben der Zielgruppe oder den Zielgruppen auch die Nutzungssituation und Zielsetzung der handelnden Person(en) berücksichtigt werden müssen. Nur wenn ich mir ausreichend Gedanken über die Eigenschaften, Kenntnisse und Erwartungen meiner Zielgruppe mache, kann ich entscheiden, was ich überhaupt thematisiere, welche Informationstiefe ich liefere und wozu ich anleite. Ich kann von ganzen Informationsprodukten bis in kleinste Handlungsschritte sinnvoll festlegen, wie ich formuliere und bebildere. Die Eigenschaften der Zielgruppe und die Nutzungssituationen sollen weiterhin die Aufteilung der Inhalte auf unterschiedliche Informationsprodukte beeinflussen. Dies umfasst ebenfalls die Wahl von geeigneten Ausgabemedien: Nutzungsinformationen können deutlich mehr sein als nur gedruckte Anleitungen.

Nachdem klar sein sollte, welchen Stellenwert der Leser hat, könnte man berechtigt fragen: Aber wie mache ich das jetzt konkret?

Natürlich liefert die Norm keine Anleitung für den Einzelfall, aber Lösungsansätze sind durchaus vorhanden. Zunächst können die Begriffsdefinitionen helfen, Sachverhalte einzuordnen. Es sollte kein Geheimnis sein, dass Nutzungsinformationen nicht nur aus Handlungsanweisungen bestehen. Dass der Kunde nicht notwendigerweise die Zielgruppe der Nutzungsinformation sein muss, ist weniger offensichtlich. Ich finde auch die beschriebene Unterscheidung zwischen Sicherheits- und Warnhinweisen durchaus nachvollziehbar und im Alltag gut umzusetzen.

Die Norm erwähnt weiterhin einige Grundsätze, wie Anforderungen an Nutzungsinformationen erfüllt werden können. Diese Grundsätze zu verinnerlichen und im Alltag anzuwenden, kann in vielen Situationen Entscheidungen im Schreibprozess erleichtern.

Wer sich noch eindeutige und klare Vorgaben wünscht, wird von der Norm mit Sollwerten für die Typographie bedient, die allerdings nicht die Zielgruppenanalyse hinsichtlich Lesbarkeit ersetzen sollten.

Schlussendlich werden Ansätze beschrieben, wie die Qualität der geschaffenen Informationen und die gewählten Prozesse bewertet werden können.

Ein Mehrwert?

Mein Fazit zur eingangs gestellten Frage fällt recht positiv aus. Ich bin überzeugt, dass man durch die Forderungen, Empfehlungen und Klarstellungen der Norm Ansätze erhält, die sich grundsätzlich im Arbeitsalltag umsetzen lassen. Je nach Grad und Qualität der Umsetzung trägt dies höchstwahrscheinlich zu besseren Nutzungsinformationen und damit zu weniger Frustration bei.

Leider formuliert die Norm in vielen Punkten, die ich persönlich als sehr wichtig erachte, zu schwammig und ein „sollte“ wird von Verantwortlichen häufig nur als „muss nicht“ gelesen. Ob und in welchem Umfang die Umsetzung in den Technischen Redaktionen erfolgen wird, hängt wahrscheinlich auch davon ab, ob die Norm harmonisiert wird.