… für verständliche Anleitungen

verständliche Anleitungen erstellen, Karikatur von Tiki Küstenmacher
Zeichnung: Tiki Küstenmacher

Dies ist der Blog von Dietrich Juhl.
Hier finden Sie Meinungen, Ideen, Grundlagen und vieles mehr zum Thema Bedienungsanleitungen und Technische Dokumentation.

Aktuell: Workshop „Neue Konzepte für Software-Anleitungen“ am 28.04. in Hamburg

Software-Anleitungen erfordern andere Konzepte als wir bisher eingesetzt haben. Vor allem die Schritt-für-Schritt-Anleitungen sind meistens nicht mehr sinnvoll.
Moderne User Interfaces sind intuitiv benutzbar und machen Funktionen systematisch zugänglich. Trotzdem kommt die Software nicht ohne Anleitung aus, weil der Anwender einen Einstieg benötigt oder die speziellen Softwarekonzepte und Featureangebote erst verstehen muss. Dabei ist es unser Ziel möglichst „schmale“ Anleitungen zu liefern, die kostengünstig erstellt werden können und dem Anwender einen leichten, selektiv lesbaren Einstieg geben.

Software-Anleitungen, Gesamtstruktur, flexible Struktur der erweiterten Handlungsaneweisung

Im Workshop erarbeiten wir systematische Ansätze und Schlüsseltechniken für effektive Beschreibungen und Anleitungen. Vor allem die Betrachtung von Mark Baker („Every Page is Page One“), das zielorientierte Schreiben und der Einsatz von skalierbaren Strukturen öffnen neue Schreibansätze. Der arbeitsintensive Workshop bietet außerdem die Möglichkeit die Konzepte sofort auf die eigenen Beschreibungen anzuwenden.

Mehr Infos: Workshop „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“.

Verständliche Anleitungen sind mir wichtig!

Dabei ist mir vor allem die Verständlichkeit wichtig, damit unsere Anwender die Technik verstehen und ohne fremde Hilfe sicher bedienen können. Hierzu habe ich Theorien und Konzepte entwickelt, gelehrt und in Büchern zusammen gestellt, weil ich glaube, dass wir mit Knowhow gute Anleitungen schreiben können.
Ich würde mich freuen, wenn Sie mich dabei unterstützen.

Knowhow für Sie

Gute Anleitungen zu schreiben ist nicht nur eine Kunst. Knowhow und bewährte Konzepte, wie das zielorientierte Schreiben, helfen uns schnell und sicher zu formulieren. Mit meinen Büchern stelle ich Ihnen Konzepte zur Verfügung, mit denen Sie sofort schneller und besser schreiben können.
Eine Investition, die sich lohnt! Mehr Infos zu den Büchern.

Workshops für Sie

Theorien und Konzepte sind eine wichtige Grundlage für unseren Job.
Manches muss aber geübt und in die eigene Praxis umgesetzt werden. In meinen Workshops können Sie genau das tun: In kleinen Gruppen wenden Sie die Konzepte auf Ihre Texte und Anleitungen an und erfahren sofort die positive Wirkung. Mehr Infos zum Workshop „Verständliche Anleitungen“.

Personal Coaching

Sie wissen, was Sie wissen und ahnen, dass sich Kleinigkeiten verbessern lassen.
Im Personal Coaching haben Sie die einmalige Chance aufbauend auf Ihrem Wissen, Neues zu lernen. Im Einzeltraining oder in kleinen Gruppen bestimmen Sie die Themen und profitieren zu 100%. Mehr Infos zu Personal Coaching.

Technische Redakteure schreiben Technische Dokumentation und Bedienungsanleitungen

Der Beruf des Technischen Redakteurs ist noch nicht sehr alt. Ca. in den 1980er Jahren entwickelte sich ein Anspruch für verständliche Anleitungen und Technische Dokumentation. In dieser Zeit wurde auch die tekom e.V. gegründet. Ziel war das Berufsbild des Technischen Redakteurs oder Technischen Autors oder Autor für Technische Literatur zu erstellen. Seit dem haben sich viele Ausbildungen entwickelt, zuerst Umschulungsmaßnahmen, Weiterbildungsmöglichkeiten für Menschen, die schon als TR arbeiten, ca. 1985 wurde an der FH Hannover der erste Lehrstuhl für Technische Dokumentation gegründet, Rolf Schwermer war der erste Professor.

Studiengänge für Technische Dokumentation und die Zertifizierung der tekom, Ausbildungen, Seminare, Workshops, Weiterbildungen

Viele Weiterbildungs Institute und Fachhochschulen bieten heute eine Ausbildung von Technischen Redakteuren an, z.B. WBS, tecteam GmbH, TAE, Technische Akademie Esslingen, Universitäten, Hannover, Karlsruhe, Furtwangen, Aalen, München, Roststock, Flensburg.
terkom Zertifikat
Ausbildung bei tecteam, WBS, TAE
es gibt auch Studiengänge in Fachhochschulen

Kostenlose Tipps zum erstellen von Bedienungsanleitungen

hier finden Sie viele Tipps und Systematik zum Erstellen von Bedienungsanleitungen oder Betriebsanleitungen.
So können Sie verständlich schreiben, strukturiert formulieren, nach XML strukturieren.
Vorlagen, Templates, Strukturen für best practice

Technische Dokumentation Beispiele

Im Buch von Dietrich Juhl werden viele Beispiele gezeigt, wie Anleitungen verständlich sind.

Bedienungsanleitungen für Software oder Freeware

Bedienungsanleitungen für Software müssen nach anderen Prinzipien geschrieben werden als für Maschinen und Anlagen.
Vor allem die Schritt-für-Schritt-Anleitung macht häufig bei Software keinen Sinn, weil viele SW intuitiv bedienbar ist oder bedienbar sein soll.
Besonders bei Freeware ist eine aussagekräftige Bedienungsanleitung wichtig. Wie eine Software-Anleitung geschrieben / erstellt werden kann,
damit sie verständlich ist, zeigt Dietrich Juhl in seinem Blog.
Bei Freeware ist vor allem die Leistungsbeschreibung (häufig bestimmungsgemäßer Gebrauch besonders wichtig. Dann bevor ein Anwender die Freeware installiert, möchte er sicher sein, dass diese Software seinen Bedarf erfüllt.

Verständliche Bedienungsanleitungen erstellen

Das bedeutendste Thema ist die Erstellung von verständlichen Anleitungen oder anderer Technischer Dokumentation. Dabei spielt vor allem die Informationsabsicht eine große Rolle, auf die zielorientiert strukturiert und optimiert werden kann. wie z.B. die Zielprogrammierung oder das Funktionsdesign.
Andere Methoden zielen auf Wortwahl, Gramatik, und andere sprachliche Feinheiten.
Auch das Hamburger Verständlichkeitsmodell wird vielfach noch gerne vermittelt.

Stichworte zur Technischen Dokumentation

Prozesse, Fachwissen, Review, Adobe Framemaker Rationalisieren mit System, Projektverwaltung, Projektmanagement
Korrektur, Finalisierung, Übersetzung, TMS-Systeme, Publizieren, Veröffentlichen, Mobile Dokumentation, Anleitungen für das SmartPhone
Maschinelle Übersetzung, Terminologieverwaltung, Reporting, agile Softwareentwicklung, Kundensprache, Firmenterminologie, Begriff, Benennung, Bedeutung
Suchworte, Kommunikation, Technische Kommunikation
Standardisieren, Intelligente Wissensprodukte, Industrie 4.0, digitale Welt, Digitalisierung
Konsistens
Komplexe Prozesse
Benutzerkontrolle
Screenshots, Visualisierung, Auflösung, Format JPEG, JPG, PNG, TIFF, EPS
Tools für Screenshots: SnagIt

Printdokumente, Typografie,

Onlineformate, Augmented Reality, Apps, Information 4.0, User Experiance

Künstliche Intelligenz

Buchempfehlung: Every Page is Page one, Mark Baker

Topic-based Writing for Technical Communication and the Web

Leseverhalten, Google Suche, Bedienungsanleitungen online
Querlesen, Einstieg über Suchwort, lernlogischer Aufbau
konzeptuell, klassifiziert
Value in Content
Topics
Specific Purpose
Limeted Purpuse
Scope of a topic
Task-based writing
Derived purpose
Topic Purpose and User Purpose
Purpose and finability
EPPO
Wiki, Wikipedia

Juristische und normative Anforderungen an Technische Dokumentation

Anforderungen an die interne Dokumentation
Anforderungen an die externe Dokumentation
Nationale und internationale technische Normen
Informationsquellen und Recherchemöglichkeiten
Informationsentwicklung

Normen wie die DIN EN 82079 (die gibt es auch mit kostenloser Checkliste) oder die ANSI 535 sind von besonderer Bedeutung
EMV-Richtlinie
Rechtliche Grundlagen

Phasen der Informationsentwicklung

Produkt- und Zielgruppenanalyse
Informationskonzept
Projektplanung und Organisation
Was-macht-Wer-Matrix (manchmal auch wer-macht-was-Matrix genannt)

Strukturieren und standardisieren

XML und Redaktionssysteme
Strukturieren Standardisieren XML (SGML)Redaktionssysteme: Single-Source- und Cross-Media-Publishing
Content-Management-Systeme CMS

Professionelles Deutsch

Deutsche Rechtschreibung Grammatik des Deutschen Lesbarkeit und Verständlichkeit Stilistik Sprachgebrauch in der Technischen Redaktion
Korrigieren und Redigieren
Moderne Korrespondenz und Textformen
Management
Managementfunktion und Managementaufgaben
Kostenrechnung und Wirtschaftlichkeitsbetrachtungen Kennzahlen Prozessbeschreibungen Management interner und externer Schnittstellen
Hamburger Verständlichkeitsmodell

Recherche

Recherche im Redaktionsprozess
Recherchegespräche
Recherche im Internet
Schriftliche Befragungen
Befragung von Fachleuten, Produktmanagern, Konstrukteuren
Ausprobieren am Objekt

Mehrsprachige Dokumentationserstellung und Lokalisierung

Grundlagen interkultureller Kommunikation
Computergestützte Übersetzung
Management von Projekten zur Erstellung multilingualer Dokumentation
maschinelle Übersetzung

Terminologie

Extraktion
Terminologiemanagement
Terminologiearbeit

Übersetzungsgerechte Dokumentationserstellung

Terminologie
Grundlagen der Terminologielehre, Terminologiedatenbanken, Terminologiemanagement

Optische Gestaltung/Layout

Grundlagen der Typografie Grundlagen des Layouts Einführung in die Arbeitsweise von Layoutprogrammen Bildschirmgestaltung Webseitengestaltung Bildhafte Darstellungen und digitale Bildbearbeitung Gestaltgesetze Bildhafte Darstellung von technischen und abstrakten Inhalten Digitale Bildbearbeitung Erfordernisse der Druckvorstufe

Online-Dokumentation

Grundlagen und Konzepte Formate, Tools und Techniken Online-Hilfe Standards für Online-Dokumentation

Multimediale Dokumentation

Multimediale Elemente in der Dokumentation Interaktive Programme Multimedia-Werkzeuge und Formate Multimedia-Programmierung
Usability Testing

Grundlagen benutzerorientierter Gestaltung

Usability-Methoden Durchführung eines Usability-Tests
Datenbanken
Grundlagen: Einsatz von Datenbanken und relationale Datenmodellierung

Structured Query Language (SQL) Anwendung von SQL in Datenbanksystemen Konzeption und Implementierung von Datenbankanwendungen

Qualitätsmanagement in der Technischen Dokumentation

Grundlagen des Qualitätsmanagements (QM) Qualitätsmanagement in der Technischen Dokumentation

KVP, QM-Regelkreise und Qualitätsbewertung in der Technischen Dokumentation

Praxis der Qualitätssicherung in der Technischen Dokumentation

Soft- und Hardware

Hardware Netzwerke und Betriebssysteme Gebräuchliche Software in der Technischen Kommunikation
Produktion
Druck und Vervielfältigung Konfektionierung Dokumentenausgabe mit PDF Kommunikation, Rhetorik, Gesprächstechnik, Präsentieren
Kommunikation Körpersprache Richtig sprechen Rhetorik Gesprächstechnik Präsentieren

Braucht man eine Technische Dokumentation?

Solche Dokumente sind rechtlich vorgeschrieben, juristische Anforderungen, laut Maschinen-Richtlinie und für das CE-Kennzeichen erforderlich. Auch der Hersteller hat ein Interesse, sich vor Haftungsansprüchen zu schützen. Vor allem Sicherheitshinweise und Warnhinweise werden oft als wichtig dargestellt. Häufig wird eine rechtssichere Technische Dokumentation gefordert.

Stellenangebote und Jobs für Technische Redakteure oder Technical Writer

Es werden immer wieder viele Jobs für Technische Redakteure angeboten. Auch ältere Mitarbeiter haben hier gute Chancen. Gesucht werden meistens Menschen mit einem sprachlichen oder technischem Studium, inzwischen gibt es auch Studiengänge oder Weiterbildungen für Technische Redakteure. gerne gesehen sind Abschlüsse von Fachhochschulen oder Weiterbildungsinstituten wie tecteam, WBS, TAE. Gerne gesehen sind auch Absolventen mit dem tekom Zertifikat / tekom Zertifizierung.

Stellenportale

Dienstleister für Technische Dokumentation
Fachkräfte, Quereinsteiger, Branchenkennzahlen
Prozessoptimierung
Bundesanstalt für Arbeit, Berufskennziffer 82144
tekom, Kompetenzrahmen, Erstellungsprozess
Bewerbung als Technischer Redakteur

Ingenieurwissenschaften, Technische Berufsausbildung, Medien und Kommunikationswissenschaften,
Übersetzung, Lokalisierung, Übersetzer, Sprachwissenschaften und Kulturwissenschaften
Geisteswissenschaften, Pädagogik, Psychologie
Kaufmännische Berufsausbildung
Chancen für Bewerber, Kompetenz, Auffassungsgabe, Deutsche Sprache

 

Content-Management-Systeme CMS für die Technische Dokumentation

Viele Anleitungen werden nach wie vor mit MS Word erstellt. Das genügt vielfach. Wenn aber viele Varianten oder die Übersetzung in viele Sprachen erforderlich ist, eignet sich ein Content-Management-System, wie Schema ST4 besser.

Technische Dokumentation rechtssicher erstellen, Rechtssicherheit Anleitungen

Meistens herrscht der Wunsch vor, dass Anleitungen, Bedienungsanleitungen, Bedienungshandbücher, Manuals oder andere Technische Dokumentation rechtssicher sein sollen.
Dabei wird häufig verkannt, dass die eigentliche Verständlichkeit das wesentliche Kriterium für Qualität ist.
Rechtssicherheit bei Technischer Dokumentation
Normen, Gesetze, Vorschriften
Produkthaftung nach dem Produkthaftungsgesetz oder nach BGB 823
Wie kann ich meine Anleitung rechtssicher machen?
Welche Gesetze und Vorschriften muss ich einhalten?
Muss ich mich an Normen halten?

Produkthaftung, Rechtssicherheit, wer haftet im Schadensfall?

Haftet der Technische Redakteur bei Personenschäden?
Wie kann sich der Hersteller, der Technische Redakteur vor Ansprüchen schützen?
Produkthaftung in USA: Da denkt man gleich an die Katze in der Mikrowelle, zum Trocknen.
Produkthaftungsgesetz ProdHaftG
Produkthaftung und Produzentenhaftung
Informationspflicht, verschuldensunabhängig
Personenschaden, Warnhinweise, Sicherheitshinweise
Arbeitnehmer-Haftung als Technischer Redakteur
Versicherung, Haftpflichtversicherung
Nutzer missachtet Anleitung
Sachkenntnis, Voraussetzungen, notwendig
Instruktionsfehler
ProdSG, Produktsicherheitsgesetz
Barrierefrei, Test, Reviews
Produktbegleitende Dokumente, Dokumentation