Die unsichtbare Frau

Gendergerechte Sprache in der Technischen DokumentationZu Beginn gleich ein paar provokante Fragen vorweg: Sind Frauen in der Technischen Dokumentation unsichtbar? Entfalten Anleitung ihre volle Wirkung für die gesamte Leserschaft – oder doch nur für die (männliche) Hälfte?
Diesen Fragen wollen wir hier nachgehen und dabei einen Blick auf (alte) Gewohnheiten, relevante Urteile, anekdotische Befunde und wissenschaftliche Studien werfen. Weiterlesen

Fallstricke bei der Standardisierung von technischem Content

Fallstricke bei der Standardisiserung von technischem Content

Ohne Standardisierung – da werden Sie mir sicher zustimmen – ist moderne Technische Redaktion nicht machbar. Ein Handbuch oder eine mobile Dokumentation, in dem jeder Warnhinweis anderen Regeln folgt, in dem man Handlungsschritte nicht von beschreibenden Informationen unterscheiden kann oder die verwendete Terminologie nach Kraut und Rüben anmutet – das will keiner.

Und das nicht hauptsächlich deswegen, weil so ein Durcheinander irgendwie nicht „schön“ wäre. Es geht vielmehr darum, dass nur eine nachhaltige Standardisierung das empfindliche Gleichgewicht herstellen kann zwischen den heutigen Anforderungen an Technischen Content: Weiterlesen

Strukturierungsmodelle für die Technische Redaktion

Was bringt ein Strukturierungsmodell?

Es ist ja nicht gerade so, dass es in der Technischen Redaktion zu wenige Strukturierungs- und Informationsmodelle gibt. DITA, Information Mapping, Funktionsdesign, PI-Mod oder diverse hausinterne Eigenentwicklungen – in der Technischen Redaktion hat man die Qual der Wahl. Deswegen wollen wir hier auch nicht im Detail auf die diversen Strukturierungs- und Informationsmodelle eingehen, sondern ein paar Tipps geben, wie man das passende Modell für die eigene Technische Redaktion findet. Weiterlesen

Was ist eigentlich Technische Dokumentation?

Was ist Technische Dokumentation?Ist Ihnen der Begriff Technische Dokumentation bekannt? Falls ja, dann haben Sie diesen bestimmt schon jemandem erklären wollen, nur um dann bei „Wo fange ich jetzt eigentlich an?“ oder „Das hat was mit Bedienungsanleitungen zu tun.“ stehenzubleiben.

Vielleicht kann man den Begriff am einfachsten durch einen typischen Entstehungsprozess erklären, also von den Gedanken zur Zielgruppe über die Nutzersituation bis zur Form der Dokumentation. Weiterlesen

Brexitfolgen: Neue Dokumentationsrichtlinie der EU

Der Brexit und seine Folgen für die Technische DokumentationAuch wenn uns der ganze Brexit wie ein Aprilscherz vorkommt, aber gar keiner ist: Diese Meldung ist natürlich dem Datum geschuldet, aber wer weiß, was da noch auf uns zukommt… 

Die EU-Kommisssion warnt Technische Redaktionen vor den Konsequenzen eines harten Brexit. Bei einem ungeregelten Austritt kämen demnach erschwerte Anforderungen auf die Hersteller von Produkten zu. Weiterlesen

Leichte Sprache mit Fundament

Rezension „Leiche Sprache – Kein Regelwerk“Leichte Sprache ist für uns im doctima Blog ja ein Thema, das uns seit vielen Jahren begleitet. Und nun gibt es endlich eine Neuerscheinung zu melden, auf die ich persönlich seit vielen Jahren gewartet habe. Das Buch, das diese Lücke schließt, heißt „Leichte Sprache – kein Regelwerk“. Im ersten Moment mag dieser Titel ein wenig verwundern. „Kein Regelwerk“ – Ist nicht genau ein Regelwerk das, was man für leichte Sprache braucht? Weiterlesen

Fehlermeldungen, die wirklich weiterhelfen

Fehlermeldungen in Apps und Websites richtig schreiben„Warum funktioniert das nicht?“ „Was ist denn jetzt schon wieder?“

Diese Gedanken kommen schon mal auf beim alltäglichen Umgang mit Apps, Websites und Programmen. Auch wenn man sie ungern sieht: Eine Fehlermeldung hilft an dieser Stelle weiter – wenn sie gut ist.

Vor kurzem hatten wir bei doctima die Aufgabe, für einen Kunden Fehlermeldungen für eine App zu erstellen. Der erste Gedanke: „So schwer kann das gar nicht sein. Wir schreiben ja auch Sicherheitshinweise und eigentlich ist das ganz ähnlich.“ Eigentlich – und eigentlich auch wieder nicht, denn Fehlermeldungen benötigen eine etwas andere Expertise. In diesem Blogpost gebe ich einen kleinen Einblick in unsere Erfahrungen mit diesem spannenden Thema und ein paar Tipps, wie Sie selber gute Fehlermeldungen erstellen. Weiterlesen

Schreiben und checken

Rezension Checkliste Schreibprozess, Wymann & NeffMit Checklisten beschäftigt sich nicht nur meine Kollegin Ulrike (z. B. hier und hier), sondern auch ein utb-Ratgeber, der vor kurzem den Weg zu mir auf den Schreibtisch gefunden hat. Christian Wymann und Franz Neff haben eine „Checkliste Schreibprozess“ vorgelegt. Sie soll wissenschaftlich Arbeitenden helfen, ihre Schreibprojekte bewusster zu steuern und einen eigenen Weg für die Gestaltung ihrer Schreibprojekte zu finden.

Mich haben bei diesem Buch vor allem zwei Fragen bewegt:

  • 1. Wie gut lässt sich mit dem Buch ein Schreibprozess gestalten?
  • Und 2. Was davon lässt sich auf die Technische Redaktion übertragen?

Die Anforderungen sind hier ja oft anders als in der Wissenschaft… Weiterlesen

Barrierefreie Kommunikation: ein Handbuch (Buchrezension)

Von Bahnhöfen über Duschkabinen bis zu Internetseiten – dem Schlagwort „Barrierefreiheit“ begegnet man seit einigen Jahren in fast allen Lebensbereichen.

Mit dem „Handbuch Barrierefreie Kommunikation“ ist nun ein 800-seitiges Kompendium erschienen, das den vielschichtigen Bereich der zwischenmenschlichen Verständigung unter diesem Aspekt behandelt. Wie gut das gelingt und wer von diesem Handbuch profitieren kann – wir haben es uns genauer angeschaut.

Weiterlesen