Technische Dokumentation

Um Kosten bei der Technischen Dokumentation zu sparen, sind wiederverwendbare Grafiken eine gute Möglichkeit. Der Änderungsaufwand für solche Abbildungen ist minimal, da meisten nur Positionsnummer oder Symbole zu tauschen sind. Richtig aufbereitete Grafiken lassen sich in verschiedenen Kapiteln bzw. Dokumenten…

Ein Lektor für eine Technische Dokumentation sollte sich an folgende Qualitätskriterien halten: Übersichtlichkeit: Sind die Informationen übersichtlich dargestellt?Vollständigkeit: Fehlen auch keine Informationen?Verständlichkeit: Sind die vorhanden Informationen verständlich?Nachvollziehbarkeit: Ist der Informationsgehalt nachvollziehbar?Korrektheit: Sind Informationen fachlich korrekt?Minimalismus: Wiederholen sich bekannte Informationen?

Ein Lektorat bei einer Technischen Dokumentation ist ein wichtiges Qualitätskriterium. Es ist wichtig die fertige Anleitung von einem zweiten Technischen Redakteur prüfen zu lassen. Ganz nach dem Prinzip „4 Augen sehen mehr wie zwei“ ist es möglich so erst übersehene…

Aspekte für die Qualitätssicherung einer Technischen Dokumentation erfolgen nach dem bekannten PDCA-Zyklus. P (Plan) = Planen D (Do) = Umsetzen C (Check) = Prüfen A (Act) = Handeln Zuerst sind in der Planungsphase Konzepte für die Technische Dokumentation zu entwickeln…

Unter den Produktspezifikationen versteht man die technischen und funktionalen Aspekte eines Produktes seitens eines Herstellers oder Verbrauchers. Dazu gehören auch technische Daten, geometrische Ausmaße und die Zusammensetzungen von Betriebsstoffen. Die Produktspezifikationen sind in der Technischen Dokumentation abgebildet und sind auch…

Der Informationsbedarf den eine Technische Dokumentation abdecken muss, hängt von der jeweiligen Zielgruppe ab. Die Zielgruppen unterscheiden sich durch typische Merkmale. Diese können das Alter, die berufliche Bildung oder andere verhaltensorientierte Merkmale sein. Auch Psychologischen Merkmale wie Motivation, Meinungen oder…

In der Technischen Dokumentation kommt eine Was-macht-wer-Matrix bei der Definition der Zielgruppe zum Einsatz. Diese Matrix bildet Handlungsorientiert ab, welche Personen welche Handlungen mit dem Produkt durchführen und welches Wissen dafür vorauszusetzen ist. Der Redakteur, welcher die Technische Dokumentation erstellt,…

Für Geräte, die unter die EMV-Richtlinie fallen, müssen Informationen zur Nutzung des Gerätes in einer Betriebsanleitung enthalten sein. Dazu zählen unter anderem Angaben über Vorkehrungen, die bei Montage, Installation, Betrieb oder Wartung des Gerätes zu treffen sind.

Sinnvollerweise erscheinen in der Technischen Dokumentation die Inhaltspunkte in der Reihenfolge entsprechend dem Lebenszyklus der Maschine. Demnach beginnt eine Betriebsanleitung nach den allgemeinen Hinweisen mit Installation und Inbetriebnahme, geht dann vom Normalbetrieb über andere Lebensphasen wie Wartung, Reparatur, Störungsbehebung und…

Die digitale Technische Dokumentation bietet einige Vorteile in der Navigation. So ist das Auffinden von Informationen im digitalen Dokument durch Suchfunktionen viel einfacher als auf der Papierfassung. Relevante Informationen wie Sicherheitshinweise lassen sich schnell in einer pdf-Datei mit entsprechenden Stichworten…