Meine Bücher und E-Books zur Technischen Dokumentation

Meine praxisnahen Bücher zum Thema Technische Dokumentation unterstützen Sie beim Erstellen verständlicher, benutzerfreundlicher Benutzerhandbücher und Online-Hilfen. Mit klaren Regeln und Empfehlungen.

NEU: Rich Documentation Design Konzept

Eine Technische Dokumentation ist umso wertvoller, je schneller sie genau die Informationen liefert, die ihre Nutzer gerade brauchen. Wie ein Energie-Riegel für einen Sportler liefert sie bei wenig Volumen viele sofort verfügbare Kalorien. Das Rich Documentation Design Konzept unterstützt das Erstellen einer solchen Dokumentation mit hoher „Nährstoffdichte“, reich an unmittelbar verwertbaren Inhalten, arm an überflüssigem Ballast.

Achtelig, Marc
Rich Documentation Design Konzept
Methoden für eine kompakte Technische Dokumentation mit maximalem Nutzwert

Komplett in deutscher Sprache
59 Seiten im A4-Format

Die meisten Menschen können heute mit Technik wesentlich besser umgehen als früher. Gleichzeitig wird die Bedienung vieler Produkte immer einfacher. Viele klassische Dokumentationskonzepte jedoch fußen noch immer auf den Dogmen „Konsistenz“ und „Vollständigkeit“.

Angesichts der Fülle an Funktionen und Einstellmöglichkeiten, die viele Produkte heute bieten, sind solche Dokumentationen kaum noch zu bewältigen – weder für die Autoren noch für die Nutzer. Trotz des hohen Erstellungsaufwands erfahren Nutzer in einer solchen Dokumentation oft viel Nutzloses und Triviales. Im Extremfall zum Beispiel, dass sie mit der Funktion „Speichern“ ihre Daten speichern können, oder dass die Funktion „Drucken“ zum Drucken eines Dokuments dient. Die wenigen wichtigen und relevanten Informationen, Hintergründe und Zusammenhänge gehen darin unter und werden nicht gefunden.

Erstellung, Pflege, Übersetzung und Druck der Dokumentation sind teurer als nötig. Dennoch ist das Ergebnis nicht optimal. Nutzer müssen mühsam werthaltige Inhalte von irrelevantem Ballast trennen. Das kostet Zeit und Energie. User Experience? Negativ.

Dies bedeutet nicht, dass etablierte Dokumentationskonzepte und -Methoden ungeeignet sind! Aber es ist Zeit, sie neu zu interpretieren, neu zu leben und an der einen oder anderen Stelle umzudenken. Außerdem ist es Zeit, stärker zu berücksichtigen, dass viele Dokumentationen heute Onlinedokumentationen sind, die im Vergleich zu einer auf Papier gedruckten Dokumentation oder zu einer PDF-Datei ganz andere Möglichkeiten bieten.

Seit mehr als 30 Jahren Beratungs- und Redaktionstätigkeit begegnet mir diese Thematik in nahezu jedem Projekt. Mit steigender Dringlichkeit. Um Lösungsansätze zu systematisieren und auch andere davon profitieren zu lassen, entstand das Rich Documentation Design Konzept mit seiner Impuls-Technik und seinen Minimal Brainwork Prinzipien.

Übrigens: Ich biete auch eine Schulung zum Rich Documentation Design an.

Basiswissen Technische Dokumentation

Sie müssen eine Technische Dokumentation erstellen? Sie haben nur wenig Zeit, aber das Ergebnis soll dennoch gut werden? Das Buch liefert Ihnen hierzu praktisch leicht umsetzbare Tipps und zahlreiche einprägsame Beispiele – frei von theoretischen Abhandlungen und linguistischen Fachbegriffen.

Achtelig, Marc
Basiswissen Technische Dokumentation:
„How to Write That F***ing Manual“ – Ohne Umschweife zu benutzerfreundlichen Handbüchern und Hilfen
Zweisprachige Ausgabe Englisch + Deutsch
Ca. 256 Seiten; ISBN der Druckausgabe: 978-3-943860-01-6

Auch verfügbar als E-Book zum sofortigen Download:

Arbeiten Sie in der Entwicklung, im Marketing oder im Produktmanagement? Stehen Sie vor der Aufgabe, für eines Ihrer Produkte eine Technische Dokumentation zu erstellen oder zu verbessern? Soll Ihr Benutzerhandbuch oder Ihre Online-Hilfe richtig gut werden, Sie haben aber nicht die Zeit zum Studium dutzender allumfassender Fachbücher?

„Basiswissen Technische Dokumentation“ liefert Ihnen das Grundwissen und die Grundlagen zum Erstellen verständlicher Technischer Dokumentation. Das Buch enthält eine übersichtliche Zusammenfassung der Regeln und Prinzipien, auf die es wirklich ankommt. Wenn Sie den gegebenen Empfehlungen folgen, wird dies die Qualität Ihrer Dokumente nachhaltig verbessern – bei minimalem Aufwand.

Das Buch bietet praktisch leicht umsetzbare Tipps und zahlreiche einprägsame Beispiele – frei von theoretischen Abhandlungen und linguistischen Fachbegriffen.

Behandelte Themen:

• Prinzipien der Strukturierung, z. B. Bilden von Kapiteln und Hilfethemen, Wählen der richtigen Überschriften und Festlegen der bestmöglichen Informationsreihenfolge
• Grundlagen zu Layout und Formatierung
• Allgemeine Regeln zum Thema verständliches Schreiben
• Besondere Schreibregeln auf Abschnittsebene
• Besondere Schreibregeln auf Satzebene
• Besondere Schreibregeln auf Wortebene
• FAQ zu Grammatik und Wortwahl

Wichtiger Hinweis:

Viele Handbücher und Online-Hilfen werden auch im deutschen Sprachraum zunächst in englischer Sprache erstellt und entweder gar nicht oder erst später ins Deutsche übersetzt. Um Sie in allen Szenarien gleichermaßen unterstützen zu können, ist diese Ausgabe des Buchs zweisprachig aufgebaut:

• Englisch: Alle Themen, die primär für die englische Sprache gelten, sind in englischer Sprache verfasst. Alle global relevanten Themen werden ebenfalls in englischer Sprache behandelt. Dabei sind Grammatik und Wortwahl bewusst einfach gehalten. Durchschnittliche Englischkenntnisse reichen zum Verständnis vollkommen aus.
• Deutsch: Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.

Reihe „Best Practices Technische Dokumentation“

„Best Practices Technische Dokumentation“ ist eine Reihe konsequent praxisorientierter Bücher, die den kompletten Prozess der Erstellung von Benutzerhandbüchern, Online-Hilfen, Screencasts und anderer Formen von „User Assistance“ umfassen.

Jeder Band der Reihe deckt dabei eine bestimmte Aufgabe im Gesamtprozess ab, sodass Personen, die nur an einzelnen Prozessschritten der Erstellung beteiligt sind, sich ganz auf diesen Schritt konzentrieren können.

Die Bücher der Reihe vermeiden jede langatmige Theorie und liefern stattdessen Best-Practices, praktisch anwendbare Lösungen, eindeutige Empfehlungen, Arbeitshilfen und einprägsame Beispiele, die Sie einfach auf Ihre eigene Arbeit übertragen können.

Übrigens: Ich biete auch Schulungen zum Thema Technische Dokumentation an, ebenso wie Beratungen rund um die Technische Dokumentation. Oder ich erstelle Ihre Technische Dokumentation schlüsselfertig für Sie.

Planning and Structuring User Assistance

Achtelig, Marc
Best Practices Technische Dokumentation:
Planning and Structuring User Assistance – Wie Sie Handbücher, Online-Hilfen und andere Formen Technischer Dokumentation benutzerfreundlich aufbauen und den Informationszugriff erleichtern
Zweisprachige Ausgabe: Englisch + Deutsch
Ca. 202 Seiten; ISBN der Druckausgabe: 978-3-943860-05-4

Auch verfügbar als E-Book zum sofortigen Download:

Selbst die besten Informationen sind wertlos, wenn Benutzer sie nicht finden. Eine benutzerfreundliche Struktur und Navigation zu schaffen, ist mindestens ebenso wichtig wie gut geschriebene Inhalte.

Allerdings ist die Strukturierung einer Technischen Dokumentation oft nicht so einfach, wie es auf den ersten Blick erscheint:

• Wenn Sie denken, dass die Struktur Ihres Dokuments der Struktur der Komponenten und Funktionen Ihres Produkts folgen sollte, liegen Sie falsch.
• Wenn Sie denken, dass die Dokumentform, die Sie selbst bevorzugen, auch das ist, was Ihre Kunden bevorzugen, liegen Sie falsch.
• Wenn Sie denken, dass alle Ihre Informationen wichtig sind, liegen Sie auch falsch.

Dieses Buch zeigt Ihnen, wie Sie Ihre Dokumente so strukturieren, indexieren und verlinken, dass Leser die enthaltenen Informationen auch tatsächlich finden.

Behandelte Themen:

• Allgemeine Strukturierungs-Prinzipien, die allen Gliederungsentscheidungen zugrunde liegen.
• Medien auswählen: Sollten Sie ein gedrucktes oder druckbares Benutzerhandbuch (PDF) bevorzugen, eine Online-Hilfe oder beides? Welche Informationen kommen ins Handbuch, welche in die Hilfe? Welches Hilfe-Format sollten Sie verwenden? Sind kontextsensitive Hilfeaufrufe möglich? Sollten Sie interaktive Funktionen einbauen? Ist es sinnvoll, interaktive Funktionen zur Beteiligung und Vernetzung der Benutzer vorzusehen?
• Dokumente planen: Sollten Sie alle Informationen in ein einziges Dokument aufnehmen oder lieber mehrere einzelne Handbücher für jeweils unterschiedliche Anwendungszwecke und Benutzergruppen erstellen? Wie sollten Sie Ihre Dokumente betiteln?
• Hauptabschnitte innerhalb der Dokumente planen: Aus welchen Hauptabschnitten sollte Ihr Dokument bestehen? Gibt es bestimmte Standardabschnitte, die Sie nicht vergessen dürfen?
• Einzelthemen planen: Welche Informationstypen benötigt Ihre Zielgruppe? Wie sollten Sie die einzelnen Kapitel oder Hilfe-Topics in Ihren Dokumenten aufbauen und benennen?
• Reihenfolge der Abschnitte und Themen planen: Wie sollten Sie die Abschnitte, Kapitel und Themen in Ihren Dokumenten anordnen? Was kommt zuerst, was kommt später?
• Navigation planen: Welche Navigationsmittel sollten Sie in gedruckten Dokumenten vorsehen, welche Navigationsmittel in Online-Hilfen? Wo sollten Sie Links und Querverweise anbieten und wo nicht?

Wichtiger Hinweis:

Viele Handbücher und Online-Hilfen werden auch im deutschen Sprachraum zunächst in englischer Sprache erstellt und entweder gar nicht oder erst später ins Deutsche übersetzt. Um Sie in allen Szenarien gleichermaßen unterstützen zu können, ist diese Ausgabe des Buchs zweisprachig aufgebaut:

• Englisch: Alle Themen, die primär für die englische Sprache gelten, sind in englischer Sprache verfasst. Alle global relevanten Themen werden ebenfalls in englischer Sprache behandelt. Dabei sind Grammatik und Wortwahl bewusst einfach gehalten. Durchschnittliche Englischkenntnisse reichen zum Verständnis vollkommen aus.
• Deutsch: Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.

Designing Templates and Formatting Documents

Achtelig, Marc
Best Practices Technische Dokumentation:
Designing Templates and Formatting Documents – Wie Sie Benutzerhandbücher und Online-Hilfen attraktiv und gut lesbar gestalten, und wie Sie effiziente Formatvorlagen erstellen
Zweisprachige Ausgabe: Englisch + Deutsch
Ca. 260 Seiten; ISBN der Druckausgabe: 978-3-943860-07-8

Auch verfügbar als E-Book zum sofortigen Download:

Ästhetik ist nicht das Einzige, was Sie beim Erstellen einer Formatvorlage anstreben sollten. In Technischer Dokumentation, wie Benutzerhandbüchern und Online-Hilfen, sind „Usability“, Lesbarkeit und Einfachheit mindestens ebenso wichtig.

Das Design soll das Auge des Betrachters erfreuen, gleichzeitig muss es die Inhalte klar und übersichtlich kommunizieren. Absatzformate und Zeichenformate sollten beim Schreiben des Dokuments einfach zu handhaben sein. Der Layout-Prozess sollte so weit wie möglich automatisiert werden. Da Technische Dokumentation in der Regel häufig aktualisiert wird, ist ein automatisierter Layout-Prozess hier wesentlich wichtiger als in anderen Buchtypen. Wenn Sie z. B. einen neuen Absatz in ein Dokument einfügen, darf dies nicht dazu führen, dass Sie alle nachfolgenden Seitenwechsel von Hand neu optimieren müssen – ganz zu schweigen von Seitenzahlen, Querverweisen, dem Inhaltsverzeichnis und dem Index.

Absatzformate und Zeichenformate zu definieren, die beim Erstellen und Pflegen eines Dokuments effizient anwendbar sind, erfordert viel Erfahrung als Technischer Redakteur. Die in diesem Buch gegebenen Empfehlungen sind die Essenz dieser Erfahrung.

Alle Kapitel enthalten zahlreiche Beispiele, die Sie als Inspiration und Ausgangspunkt für Ihre eigenen Designs nutzen können.

Das Buch richtet sich sowohl an Grafiker und Mediengestalter, die eine Formatvorlage für ein Benutzerhandbuch oder eine Online-Hilfe erstellen wollen, als auch an Autoren, die ihre eigenen Designs und Style-Sheets entwerfen. Es enthält klare Regeln und unmissverständliche Empfehlungen – keine lange Theorie, keine Abschweifungen, keine hochtrabende Fachsprache.

Behandelte Themen:

• Grundlagen zum Layout
• Satzspiegel festlegen
• Schriftarten und Abstände wählen
• Manuelle Formatierungen vermeiden
• Semantische Formate vorsehen
• Formate hierarchisch organisieren
• Empfohlene Bildschirm-Layouts
• Empfohlene Seiten-Layouts
• Empfohlene Tabellen-Designs
• Empfohlene Absatzformate
• Empfohlene Zeichenformate

Wichtiger Hinweis:

Viele Handbücher und Online-Hilfen werden auch im deutschen Sprachraum zunächst in englischer Sprache erstellt und entweder gar nicht oder erst später ins Deutsche übersetzt. Um Sie in allen Szenarien gleichermaßen unterstützen zu können, ist diese Ausgabe des Buchs zweisprachig aufgebaut:

• Englisch: Alle Themen, die primär für die englische Sprache gelten, sind in englischer Sprache verfasst. Alle global relevanten Themen werden ebenfalls in englischer Sprache behandelt. Dabei sind Grammatik und Wortwahl bewusst einfach gehalten. Durchschnittliche Englischkenntnisse reichen zum Verständnis vollkommen aus.
• Deutsch: Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.

Writing Plain Instructions

Achtelig, Marc
Best Practices Technische Dokumentation:
Writing Plain Instructions – Wie Sie Handbücher, Online-Hilfen und andere Formen Technischer Kommunikation schreiben, die jeder Benutzer versteht
Zweisprachige Ausgabe: Englisch + Deutsch
Ca. 524 Seiten; ISBN der Druckausgabe: 978-3-943860-09-2

Auch verfügbar als E-Book zum sofortigen Download:

Benutzer wollen leicht lesbare Handbücher mit kurzen Sätzen, einfachen Wörtern und unmissverständlichen Anleitungen. Leider ist es wesentlich schwieriger eine einfache Anleitung zu schreiben als eine, die nur ein Experte versteht. Das Schreiben komplizierter Texte ist einfach – das Schreiben einfacher Texte ist kompliziert.

Dieses Buch zeigt Ihnen, wie Sie einfache Texte schreiben, die Benutzer unterstützen, statt sie zu überfordern. Da es in dem Buch um verständliche Inhalte geht, vermittelt das Buch auch seine eigenen Inhalte verständlich und ohne Umschweife. Das Buch ist garantiert frei von langatmiger Theorie und hochtrabendem Fachvokabular. Es liefert klare Empfehlungen und prägnante, einprägsame Beispiele, die Sie leicht auf Ihre eigene Arbeit übertragen können.

Behandelte Themen:

• Allgemeine Schreibtechniken, die Ihre Texte einfach, übersichtlich und leicht verständlich machen.
• Auf Kapitel-Ebene: Regeln zum Erstellen der grundlegenden Informationstypen „Concept“, „Task“ und „Reference“.
• Auf Absatzebene: Regeln zum Schreiben der textbildenden Standardelemente, wie Überschriften, Zwischenüberschriften, schrittweise Anleitungen, Aufzählungen, Tabellen, Warnhinweise, sonstige Hinweise, Tipps, Beispiele, Querverweise und Links.
• Auf Satzebene: Regeln zum Bau verständlicher, eindeutiger Sätze.
• Auf Wortebene: Tipps zur Verwendung einfacher Wörter und einheitlicher Benennungen.
• FAQ zu Rechtschreibung und Zeichensetzung.
• FAQ zu Wortwahl und Grammatik.
• Standardisierte Begriffe und Formulierungen.

Wichtiger Hinweis:

Viele Handbücher und Online-Hilfen werden auch im deutschen Sprachraum zunächst in englischer Sprache erstellt und entweder gar nicht oder erst später ins Deutsche übersetzt. Um Sie in allen Szenarien gleichermaßen unterstützen zu können, ist diese Ausgabe des Buchs zweisprachig aufgebaut:

• Englisch: Alle Themen, die primär für die englische Sprache gelten, sind in englischer Sprache verfasst. Alle global relevanten Themen werden ebenfalls in englischer Sprache behandelt. Dabei sind Grammatik und Wortwahl bewusst einfach gehalten. Durchschnittliche Englischkenntnisse reichen zum Verständnis vollkommen aus.
• Deutsch: Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.

Handbücher und Hilfen anschaulich illustrieren und animieren

Achtelig, Marc
Best Practices Technische Dokumentation:
Handbücher und Hilfen anschaulich illustrieren und animieren – Bilder, Videos, Interaktion
Komplett in deutscher Sprache
Ca. 360 Seiten; ISBN der Druckausgabe: 978-3-943860-11-5

Auch verfügbar als E-Book zum sofortigen Download:

Worte sind nicht immer das beste Medium, um technische Informationen zu vermitteln. Manchmal kann ein Bild, eine kleine Animation oder ein kurzes Video innerhalb weniger Sekunden intuitiv zeigen, was Worte kaum zu beschreiben vermögen.

Es gibt aber auch Fälle, in denen Bilder viel zu umständlich sind in der Informationsvermittlung und Videos viel zu langsam. Für eine effektive Technische Kommunikation müssen Bilder und Videos genau dort eingesetzt werden, wo sie ihren optimalen Nutzen entfalten, und sie müssen jeweils so gestaltet sein, dass sie ihre jeweilige Botschaft klar vermitteln.

Dieses Buch zeigt Ihnen die Prinzipien einer effektiven Visualisierung.

Behandelte Themen:

• Wahl des richtigen Mediums und Orts: Was ist im jeweiligen Einzelfall besser: Text? Bild? Animation? Video? Interaktive Komponenten? Wie viele Bilder sollten Sie einbinden und an welchen Stellen?
• Grundregeln zur Visualisierung: Allgemeine Gestaltungsprinzipien, die sowohl beim Erstellen von Bildern gelten als auch beim Erstellen von Videos.
• Bilder allgemein: Tipps zum Erstellen effektiver Bilder generell, unabhängig davon, was diese Bilder zeigen.
• Bilder von Hardware: Spezielle Tipps zum Erstellen von Zeichnungen und Fotos, die physische Geräte (Hardwarekomponenten) zeigen.
• Bilder von Software: Spezielle Tipps zum Erstellen von Screenshots und anderen Abbildungen von Software.
• Video-Design: Tipps zum Gestalten effektiver Anleitungsvideos sowie Lösungen dafür, wie sich diese Anleitungsvideos am besten in eine Technische Dokumentation einbetten lassen.
• Video-Produktion: Tipps zu Organisation und Technik beim Erstellen von Anleitungsvideos.
• Interaktive Inhalte: Anregungen zum Implementieren interaktiver Komponenten, wie interaktiver 2D- und 3D-Bilder, Hypervideos und Augmented-Reality-Anwendungen.

Wie alle Bücher der Reihe „Best Practices Technische Dokumentation“ konzentriert sich das Buch auf konkrete, in der Praxis leicht umsetzbare Tipps und Beispiele. Falls Sie Ihre Bilder und Videos nicht selbst erstellen, sondern damit einen Grafiker oder eine Agentur beauftragen, macht Sie das Buch zu einem kompetenten Auftraggeber und es vermittelt Ihnen das nötige Fachwissen, die Ergebnisse kritisch zu überprüfen.

Siehe auch meine weiteren Arbeitshilfen zur Technischen Dokumentation.

Oder lesen Sie weiter mit: Knowledge Base "Best Practices für Technische Dokumentation"