Das Dokuhelden-Blog

Wann ist eine Bedienungsanleitung gut? Natürlich dann, wenn der vorgesehene Nutzer etwas damit anfangen kann, die benötigten Informationen schnell findet und das beschriebene Produkt gut und sicher bedienen kann. Dafür gibt es Evaluierungsmethoden – sie werden in der IEC/IEEE 82079-1 explizit gefordert.

Seit einigen Jahren rückt das Thema Barrierefreiheit zunehmend in den Fokus. Was gilt es bei der Erstellung technischer Dokumentation in punkto Barrierefreiheit zu beachten?

Letztens hatten wir wieder so einen Fall. Beim Durchsehen einer Übersetzung fiel auf, dass in der Übersetzung etwas nicht stimmte – wo im deutschen Ausgangstext noch alles gepasst hatte. Woran das liegen kann, erklären wir in diesem Blog-Beitrag.

2023 wird ein spannendes Jahr für die Technische Dokumentation. In unserem Blogbeitrag stellen wir Ihnen drei einschneidende Änderungen vor, die den Alltag bei Herstellern und Dokumentationserstellern künftig prägen werden.

58 Prozent aller Unternehmen nutzen sie bereits: Redaktionssysteme für die Technische Redaktion (CCMS) sind die Power-Tools der Dokumentationserstellung. Die Dokuhelden zeigen, was ein CCMS können muss und worauf Unternehmen bei der Auswahl des richtigen Systems achten sollten. 

Die Technische Dokumentation lässt sich unterteilen in die interne Technische Dokumentation und die externe Technische Dokumentation. Die interne Dokumentation betrifft vorrangig Beteiligte innerhalb eines Unternehmens. Doch auch für die Technische Redaktion spielt sie eine große Rolle. 

Das Kerngeschäft eines Dienstleisters für Technische Dokumentation besteht darin, sich innerhalb kurzer Zeit flexibel auf unterschiedlichste Kundenanforderungen, Produkte und Branchengegebenheiten einzustellen. Dabei gibt es einiges zu beachten.

Wie viele unterschiedliche Benennungen gibt es in Ihrem Unternehmen für einen einzigen Gegenstand - zwei, drei oder noch mehr? Es lohnt sich, darüber einmal nachzudenken. Denn durch Wildwuchs bei der Wortwahl sind Missverständnisse vorprogrammiert. Dabei lassen sich diese mit wenig Aufwand vermeiden.

Wer "CMS" googelt, stellt schnell fest, dass CMS nicht gleich CMS ist. Den entscheidenden Unterschied zwischen Content-Management-Systemen, die klassischerweise für die Website-Pflege verwendet werden, und solchen, die in der Technischen Dokumentation zum Einsatz kommen, macht ein vorangestelltes „C“: Bei Component-based-Content-Management-Systemen geht es darum, Technische Dokumentation modular aufzubauen und so weit wie möglich zu standardisieren.

Der Vorschlag für die neue EU-Maschinenverordnung liegt auf dem Tisch, und zu den Neuerungen gehört der Wegfall des Printgebots. Lesen Sie hier, welche Chancen die digitale Dokumentation bietet und was es zu beachten gilt.

Ein Handbuch zu erstellen ist mit zeitlichem und personellem Aufwand verbunden und unter Umständen auch mit Übersetzungskosten. Wozu also die ganze Mühe? 

Gute Karrierechancen, vielseitige Einsatzmöglichkeiten und die Aussicht, sowohl technische, sprachliche als auch kreative Talente einsetzen zu können, machen das Studium zum Technischen Redakteur/Technischen Redakteurin äußerst attraktiv.

Kaum ein Beruf profitiert so sehr von dem Fachwissen von Quereinsteigern wie der des Technischen Redakteurs/ der Technischen Redakteurin. Dementsprechend gibt es nicht nur einen Königsweg zur Qualifikation, sondern viele. Die Vollzeit-Weiterbildung ist eine davon.

So vielfältig die Aufgabengebiete in der technischen Redaktion sind, so unterschiedlich sind auch die Wege in den Beruf. Ob Studium, Weiterbildung oder Volontariat, es gibt mehr als eine Möglichkeit, um in der Technischen Dokumentation Fuß zu fassen.

Die Arbeit eines technischen Redakteurs ist niemals wirklich abgeschlossen. Ist die Dokumentation erstellt, beginnt der Review-Prozess, in dem das fachliche Feedback zu den Entwürfen eingeholt wird. Dieser Artikel gibt Tipps, wie man gute Review-Kommentare erhält, mit denen es sich optimal weiterarbeiten lässt.

Symbole sind beliebt und allgegenwärtig, denn sie transportieren Botschaften ohne Worte. Doch kommt wirklich immer das Gemeinte an? 

Wenn ein Nutzer Ihre Anleitung in die Hand nimmt, sucht er nach ganz bestimmten Informationen. Er möchte vielleicht wissen, wie ein Gerät funktioniert oder welche Schritte er unternehmen muss, um etwas zu tun. An dieser Stelle kommen Glossar, Index und Inhaltsverzeichnis ins Spiel.

Genderneutrale Sprache hält im Alltag Einzug, ist aber nicht immer ganz einfach umzusetzen. In Anleitungen wird bisher kaum Wert auf geschlechterneutrale Formulierungen gelegt. Das muss sich ändern - aber wie?

In vielen Firmen liegt die Verantwortung für die Technischen Dokumentation – sei es aus historischen oder innerbetrieblichen Gründen – in der Marketing-Abteilung. Wird dann die Erstellung Technischer Dokumentation in eine Technische Redaktion verlagert, kommt es häufig zu Konflikten. Auf den ersten Blick prallen hier zwei Welten aufeinander, deren kleinster gemeinsamer Nenner nahezu unerreichbar erscheint. Jedoch liegt das Problem meistens nur am mangelnden Verständnis für die Arbeit und Intention der jeweils anderen Abteilung. Sind Sie auch in dieser Zwickmühle? A2 Doku GmbH empfiehlt: Schaffen Sie Verständnis im Rahmen eines Workshops.

Ein oft gehörter Satz unserer Kunden, wenn wir nach Varianten der Produkte fragen, lautet: „Eigentlich sind bei uns alle Produkte zu 95% identisch.“ Doch der Teufel steckt im Detail, sobald man sich ein Metadatenkonzept erarbeitet. Denn am Ende stellt sich nicht selten heraus, dass sich die Produkte doch deutlicher voneinander unterscheiden als gedacht. 

Einige wenige Zutaten, aber eine fast unbegrenzte Menge individueller Kombinationsmöglichkeiten – was den Burger weltweit so beliebt gemacht hat, ist auch bei vielen technischen Produkten der Schlüssel zum Erfolg. Wie bildet man die Dokumentation einer solchen Variantenvielfalt ab? Ganz einfach: Mit Taxonomien. Das Burger-Modell zeigt, wie’s geht.

Der Button „Halt“ heißt plötzlich „Stop“, und mit einem Schlag müssten hunderte von Screenshots ausgetauscht werden. Um dieses Problem zu vermeiden, hat A2 für ein Kundenprojekt die Bildschirmoberflächen im Callout-Designer von SCHEMA ST4 nachgebaut. Änderungen in der Terminologie der Oberfläche funktionieren jetzt auf Knopfdruck.

Die Hände sind ölig, die Schutzbrille voller Staub. Ausgerechnet jetzt muss der Maschinenbediener die für den nächsten Wartungsschritt erforderlichen Werte nachschlagen. Kein Problem. „Hallo Sprachsteuerung. Lies das Kapitel Öldruck in Betriebsanleitung XY vor“, sagt er und erhält prompt die gesuchten Informationen. Zukunftsmusik? Keineswegs.

Es gibt Momente, in denen es wirklich darauf ankommt, ob eine Anleitung gut und verständlich geschrieben ist. Dieser Beitrag erzählt von einem solchen Ereignis.

„Komm wir essen Opa“ – welcher Schüler kennt diesen Satz nicht? Als Musterbeispiel zum Thema Zeichensetzung zeigt er, wie schnell ein fehlendes Komma aus fürsorglichen Enkeln Kannibalen macht. 

 Was fasziniert Frauen an der Arbeit in der Technischen Redaktion? A2 hat sich anlässlich des Internationalen Frauentags bei den „Dokuheldinnen“ im Team umgehört.

Digital geht alles besser – außer Langzeitarchivierung. Daten dauerhaft zu speichern und langfristig abrufen zu können, wird aufgrund der rasanten Weiterentwicklung von Hard- und Software zum echten Problem.

„Maximalbelasteter Druckaufnehmer für Eigenkraftanalyse“ – unter diesem Namen hätte der Jahrmarktklassiker „Hau den Lukas“ wohl kaum Erfolgsgeschichte geschrieben. Aussagekräftige Handlungsverben sind eben die halbe Miete. Das gilt auch für die Technische Dokumentation.

 Verordnungen, Richtlinien und Normen begegnen einem in der Technischen Dokumentation auf Schritt und Tritt. Die entscheidende Frage ist: was verwenden und wozu?

Kennen Sie „tlh“? Die Abkürzung steht nicht für ein neues Dateiformat, sondern ist das offizielle ISO-Sprachkürzel für Klingonisch. Zugegeben, Technische Dokumentation in dieser Sprache wird selten nachgefragt. Doch für den Fall der Fälle gilt auch hier: Das A und O für ein gutes Ergebnis in der Zielsprache ist ein übersetzungsgerecht formulierter Quelltext.

Seit Einführung der Norm IEC/IEEE 82079-1:2019-05 gehört der Informationsmanagementprozess zur Technischen Dokumentation. Für Hersteller und Dienstleister ergeben sich dadurch neue Herausforderungen – und Chancen.

Das neue Minimalismusprinzip der IEC/IEEE 82079-1:2019-05 bringt selbst erfahrene Technische Redakteure ins Schwitzen. Wo endet das Notwendige, wo beginnt das Überflüssige? A2 hat sich mit dem Thema befasst.

Warn- und Sicherheitshinweise tragen maßgeblich zur Produktsicherheit bei. Idealerweise ergibt sich ihr Inhalt direkt aus der Risikobeurteilung und verbindet rechtliche, technische und sprachliche Aspekte. Doch die Realität sieht leider anders aus.

Mit dem neuen Leistungsmerkmal „Beschriftungen“ ist es seit dem Release 2020 in SCHEMA ST4 möglich, die Legendentabellen zu sogenannten „Igel-Grafiken“ dynamisch zu gestalten.