Was ist bestimmungsgemäße Verwendung und was vorhersehbarer Fehlgebrauch?

Ausgangspunkt der (externen) technischen Dokumentation sollte eine Sicherheitsbewertung des Produktes bilden. Aufbauend auf den Ergebnissen dieser Beurteilung formuliert jeder technischer Redakteur wie auch jede technische Redakteurin das Sicherheitskapitel, die technisch unvermeidbaren Restrisiken fließen in die Anleitung ein. Der Hersteller ist verpflichtet, die Anwender vor Risiken zu warnen, die bei bestimmungsgemäßer Verwendung und auch bei vorhersehbarem… [weiterlesen]

Sein oder Schein – Zielgruppen-Analyse

Immer wieder wird behauptet, dass Zielgruppen-Analyse in der Praxis von technischen Redaktionen keine Rolle spielt. Wahrscheinlich beruht diese Behauptung auf individuellen Erfahrungen. Nun hat meine Umfrage „Zielgruppe-ein unbekanntes Wesen?“ ein anderes Ergebnis geliefert. Fast alle der Befragten gaben an, sich mit der Zielgruppe ihrer Dokumentation auseinanderzusetzen. Wie ist dieser Widerspruch zu bewerten oder besteht vielleicht… [weiterlesen]

Varianten in der technischen Dokumentation (2) – Bedingte Texte im FrameMaker

Varianten existieren sowohl in der Produktwelt als auch in der technischen Dokumentation. Technischen Redakteuren stehen unterschiedliche Möglichkeiten zur Verfügung, um der Vielzahl an Varianten Herr zu werden und mit ihnen effizient zu arbeiten. In meinem ersten Beitrag zum Themengebiet „Varianten in der technischen Dokumentation“ habe ich den Einsatz von Variablen diskutiert. Diese sind geeignet, kleinere… [weiterlesen]

Redaktionsleitfaden: Kein Allheilmittel aber sinnvolles Hilfsmittel!

Im Blog von doctima findet eine interessante Diskussion über Sinn und Unsinn von einem Redaktionsleitfaden in modernen Redaktionen statt. Ausgangspunkt ist der Beitrag „DITA ohne Redaktionsleitfaden – Keine gute Idee“ von Johannes Dreikorn. Diese Diskussion möchte ich zum Anlass nehmen, noch einmal grundsätzlich auf die Bedeutung eines Redaktionsleitfadens einzugehen. Dabei geht es mir nicht um… [weiterlesen]

Ein- Zwei- oder Mehrzahl?

In der technischen Dokumentation wird meist Wert auf Kürze und Prägnanz gelegt. Vor diesem Hintergrund verzichten viele Redakteure einschließlich meiner Person auf die Verwendung von Artikeln. Die Sätze werden kürzer, aber leider kann dabei die Eindeutigkeit verloren gehen. Im Deutschen gibt es Begriffe, die nicht erkennen lassen, ob das Wort im Singular oder Plural steht… [weiterlesen]