Das Dokuhelden-Blog

„Technikpaternalismus“ bezeichnet technische Systeme und Algorithmen, die das Verhalten von Nutzern in eine bestimmte Richtung lenken und selbstbestimmte Entscheidungen teilweise einschränken – eine systemintegrierte Bevormundung also.

Die Vorteile eines Redaktionssystems (CCMS) liegen klar auf der Hand:

Ob Wiederverwendbarkeit, Modularisierung, Layoutunabhängigkeit, Steuerung von Übersetzungsworkflows, Variantenmanagement oder das gemeinsame Arbeiten an einem Dokument. All das sind Argumente, weshalb sich Unternehmen für die Einführung eines Component-based Content-Management-Systems, oder landläufig Redaktionssystem, entscheiden. Doch wie wird die Umstellung auf ein solches System zum Erfolg? Wir geben Ihnen in diesem Blogbeitrag ein paar Tipps mit auf den Weg.

Verderben viele Köche den Brei? Nicht ganz. Teamarbeit liegt in der DNA von Dienstleistern. Das bringt allerdings einige Herausforderungen mit sich. Wie Sie es schaffen, dass auch bei vielen Mitwirkenden die Qualität stimmt und Standards eingehalten werden, verraten wir Ihnen in diesem Beitrag.

Englisch ist die Sprache, in der Technische Dokumentation am häufigsten vorliegt. Daraus ergibt sich ein Problem: Diese Betriebs- und Wartungsanleitungen werden auch von Nicht-Muttersprachlern verwendet, die nur über begrenzte englische Sprachkenntnisse verfügen. Wie man englische Anleitungen klarer und einfacher schreibt, erklären wir in diesem Beitrag.

Technische Dokumentation ist keineswegs eine Erfindung der letzten Jahrzehnte. Vorbildliche Bedienungsanleitungen gibt es schon weitaus länger. Ein kurioses Beispiel fiel der Autorin jüngst in die Hände – eine „Gebrauchs-Anweisung“ mit „Rathschlägen für die Benutzung von Briefordnern“. Wir haben sie einmal aus der Perspektive der heutigen Normenanforderungen betrachtet.

Die meisten modernen Redaktionssysteme sind XML-basiert. Das heißt Inhalt, Struktur und Layout sind voneinander getrennt. Zudem ermöglichen diese Systeme, Inhalte in verschiedenen Sprachen zu verwalten. Um beim Import einer Übersetzung keine bösen Überraschungen zu erleben, sollten Sie ein paar Regeln beachten.

Alle Jahre wieder: Auch 2024 findet in Nürnberg die Quanos Connect statt. Als langjähriger Partner von Quanos lässt sich das CMS-Team von A2 Doku die zweitägige Veranstaltung am 14. und 15. Mai nicht entgehen. 

Topicorientiertes Schreiben gehört in der Technischen Dokumentation zum Handwerkszeug. Doch was genau ist ein Topic eigentlich und worauf muss ich beim topicotientierten Schreiben achten? In unserem Beitrag zeigen wir, worauf es dabei ankommt.

Die digitale Anleitung ist seit der Verabschiedung der Maschinenverordnung in aller Munde. Nichtsdestotrotz sterben Anleitungen in gedruckter Form nicht aus. Wir werfen einen Blick auf die wichtigsten Druckanforderungen.  

Wer vor zehn Jahren maschinelle Übersetzungen nutzte, las häufig abstruse Übersetzungen, die oftmals kaum zu gebrauchen waren und bestenfalls zur allgemeinen Erheiterung beitrugen. Seit einiger Zeit weist aber selbst so manche kostenfreie Übersetzungssoftware erstaunlich gute Ergebnisse auf. Sind professionelle Humanübersetzungen also bald ein Auslaufmodell oder stößt die künstliche Intelligenz an Grenzen?

Standardisierung und Strukturierung spielt beim Schreiben von Technischer Dokumentation eine große Rolle. In die gängigen Methoden sind auch Erkenntnisse über die Prozesse der Informationsverarbeitung im Gehirn eingeflossen. Warum das so wichtig ist, lesen Sie in unserem Blogbeitrag.

Künstliche Intelligenz (KI) hält Einzug in der Technischen Redaktion. Welche Möglichkeiten es für den Einsatz von KI im Dokumentationsprozess gibt, erfahren Sie im A2 Doku Blog.

„Scrollen Sie mit der Pfeiltaste nach unten …“ – Moment mal, habe ich diesen Satz nicht schon irgendwo gelesen? Oder hieß es drei Seiten vorher „Blättern Sie mit den Pfeiltasten …“? In Anleitungen kommt es leider häufig vor, dass identische Vorgänge auf unterschiedliche Weise beschrieben werden. Darunter leidet die Verständlichkeit. Für mehr Konsistenz sorgt eine gute Autorenunterstützung.

In den letzten drei Jahren ist viel passiert, was den Umgang mit Online-Meeting-Tools betrifft. Man sollte meinen, vom Grundschüler bis zur Oma sind nun alle firm und wissen was zu tun ist, damit die Technik funktioniert. Doch die Erfahrung zeigt, dass es immer noch einige Fallstricke gibt, die ein erfolgreiches Meeting verhindern. Was also tun, dass es auf Anhieb klappt?

Die meisten Anleitungen werden früher oder später übersetzt. Normative Vorgaben oder Richtlinien vieler Produkte regeln, in welchen Sprachen die dazugehörige Betriebsanleitung vorliegen muss. Vertragliche Vereinbarungen mit dem Kunden können noch weitere Sprachen erforderlich machen. Grund genug, bereits beim Erstellen einer Anleitung die Weichen für künftige Übersetzungen richtig zu stellen. 

Du oder Sie? In vielen Branchen ist die informelle Anrede Teil der Unternehmenskultur. Jung, innovativ, aufgeschlossen – all das suggeriert ein „Du“, das sich über alle Hierarchien hinwegsetzen darf. Auch im Web ist die förmliche Distanz des „Sie“ mittlerweile die Ausnahme und findet bestenfalls im Kleingedruckten Anwendung. Doch nicht jeder fühlt sich damit wohl.

Der Trend geht zur Heimarbeit. Auch wenn sich in den vergangenen Monaten viele Angestellte nach den Pandemiejahren darüber gefreut haben, wieder ins Büro zu kommen, haben sich die Anforderungen an die Arbeitswelt in den letzten beiden Jahren nachhaltig verändert. Viele Arbeitnehmerinnen und Arbeitnehmer wissen das zu schätzen und erwarten von ihrem Arbeitgeber, mobiles Arbeiten flexibel nutzen zu können. Damit die Heimarbeit gelingt und nicht zu Frust führt, haben wir ein paar Tipps, wie Sie Ihren Arbeitstag zu Hause erfolgreich gestalten.

Voll ausgestattete Coworking-Spaces rund um den Globus machen das Arbeiten theoretisch von fast jedem Ort der Welt möglich. Nicht nur digitale Nomaden wissen das zu schätzen. Auch im ganz normalen Arbeitsalltag erweisen sich die flexiblen Arbeitsraumlösungen als äußerst nützlich.

Haben Sie schon einmal ein kommentiertes Dokument erhalten und gerätselt, was der Autor des Kommentars Ihnen sagen möchte? Vielleicht haben Sie schon erlebt, dass ein Kommentar einzig aus einem Fragezeichen bestand ohne weitere Erläuterung. Heißt das nun, der Kommentator hat etwas nicht verstanden oder hält er den Inhalt für inkorrekt? Wir zeigen Ihnen, wie Sie Missverständnisse und Unklarheiten beim Redigieren vermeiden. 

UPDATE: Nach guten 15 Jahren wird die Maschinenrichtlinie 2006/42/EG durch die EU-Maschinenverordnung abgelöst. Die Verordnung trägt das Datum 14.06.2023. Am 29. Juni 2023 wurde die Maschinenverordnung im EU-Amtsblatt veröffentlicht. Am 20. Januar 2027 tritt sie in Kraft.

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.