Grundlagen der Technischen Dokumentation

Frontmatter

Kapitel 1. Grundlegendes

Zusammenfassung

Die Technische Dokumentation ist in den letzten Jahren vor allem durch gesetzliche Forderungen immer wichtiger geworden. Dennoch ist ihr Stellenwert in vielen Unternehmen immer noch geringer als wünschenswert. Dieses Buch soll Technische Redakteure unterstützen, indem es ihnen Fachwissen und Prozesswissen zur Dokumentationserstellung vermittelt.

Lars Kothes

Kapitel 2. Gesetze, Richtlinien und Normen

Zusammenfassung

Das folgende Kapitel beschäftigt sich mit den rechtlichen und normativen Grundlagen, die das Vorhandensein einer Anleitung fordern und außerdem die qualitativen Ansprüche an deren Ausführung festlegen.

Lars Kothes

Kapitel 3. Dokumentationsprozess

Zusammenfassung

Der Dokumentationsprozess (Abb. 3.1) wird von vielen Faktoren beeinflusst und ist stark abhängig von Unternehmens- und Produktstrukturen. Dieses Kapitel stellt daher beispielhaft die wichtigsten Projektphasen eines Dokumentationsprozesses vom Projektstart bis zur Auslieferung dar.

Lars Kothes

Kapitel 4. Inhalte der Anleitung

Zusammenfassung

In diesem Abschnitt werden anhand einer Beispiel-Kapitelstruktur die Inhalte einer Anleitung aufgezeigt, erläutert und mit Beispielen versehen. Die Struktur ist aufgrund der Anforderungen aus den in Kap. 2 genannten Gesetzen, Richtlinien und Normen entstanden. Je nach Produkt und Zielgruppe kann es sein, dass einige Abschnitte nicht zutreffen und entfallen oder neue Abschnitte hinzukommen. Ebenso ist die Reihenfolge der Kapitel nicht dogmatisch zu sehen. Hier können Änderungen je nach Anwendungsfall durchaus sinnvoll sein.

Lars Kothes

Kapitel 5. Anleitungen formulieren

Zusammenfassung

Alle Welt verlangt nach verständlichen Anleitungen. Doch wie schafft man es, dass eine Anleitung verständlich ist? Wie muss man Texte verfassen, damit sie von anderen leicht verstanden werden können?

Lars Kothes

Kapitel 6. Anleitungen gestalten

Zusammenfassung

Die Gestaltung von Anleitungen ist ein großes und wichtiges Thema, auch wenn es nicht zu den täglichen Aufgaben von Technischen Redakteuren gehört, Anleitungen zu gestalten. Denn im Alltag wollen wir ja Inhalte schreiben und ein einmal erstelltes und optimiertes Layout lediglich anwenden.

Lars Kothes

Kapitel 7. Sicherheitshinweise gestalten und formulieren

Zusammenfassung

Ein klares Sicherheitskonzept ist elementarer Bestandteil jeder Anleitung. Sicherheitshinweise sollen dabei einerseits den Schutz des Anwenders vor Gefahren im Umgang mit dem Produkt gewährleisten. Sie minimieren andererseits aber auch das Risiko für den Hersteller, bei einem Schaden in Haftung genommen zu werden.

Lars Kothes

Kapitel 8. Visualisierung

Zusammenfassung

Ohne Bilder geht es nicht! Es ist wohl kaum möglich, eine Anleitung zu schreiben, ohne ein Bild zu verwenden, denn Texte schreiben bedeutet immer Abstraktion, während Bilder in der Regel konkret sind. Abbildungen unterstützen also den Nutzer, damit er sich besser zurechtfindet, damit er die Texte besser einordnen kann und manchmal, damit er die Texte überhaupt verstehen kann.

Lars Kothes

Kapitel 9. Anleitungen modular erstellen

Zusammenfassung

Die Anforderungen an die Technische Dokumentation steigen stetig an. Als letztes Glied in der Kette ist die Dokumentation gezwungen, die Trends in der Produktentwicklung mitzumachen:

• kürzere Entwicklungszyklen
• kürzere Lieferzeiten
• Variantenkonstruktion
• individuelle Produkte, die mit Produktkonfiguratoren zusammengestellt werden
• standortübergreifende, verteilte Entwicklung
• Wiederverwendung von Baugruppen, Plattformkonzepte
• Globalisierung und Lieferung an Kunden in der ganzen Welt

Lars Kothes

Kapitel 10. Redaktionsleitfaden

Zusammenfassung

Der Redaktionsleitfaden ist die Bibel einer jeden Technischen Redaktion. Er vereint die typischen Inhalte eines Qualitätsmanagementhandbuchs mit den fachlichen Anforderungen aus der Technischen Dokumentation. Das folgende Kapitel beschreibt kurz die Bedeutung dieses wichtigen Arbeitspapiers, seinen Inhalt und einen Weg, diesen zu erarbeiten.

Lars Kothes

Kapitel 11. Anleitungen für den US-Markt

Zusammenfassung

Dieses Kapitel ist ein kurzer Exkurs in die „Welt der Anleitungen für den US-Markt“. Aufgezeigt und erläutert werden die grundsätzlichen Anforderungen an Anleitungen für den US-Markt.

Lars Kothes

Kapitel 12. Die Anleitung im betriebswirtschaftlichen Kontext

Zusammenfassung

Die Technische Dokumentation produziert betriebswirtschaftlich gesehen nichts anderes als Kosten, die das Produkt teurer machen. Den Nutzen sehen nur wenige. Deshalb möchte ich hier Kosten und Nutzen aufzeigen.

Lars Kothes

Kapitel 13. Quellen

Zusammenfassung

Abbildungen in diesem Buch werden mit freundlicher Genehmigung der folgenden Firmen verwendet.

Lars Kothes

Backmatter