|
Überprüfen Sie Ihre technische Dokumentation
• Hat jeder Begriff (in verschiedenen Dokumenten) eine einheitliche Bedeutung?
• Ist die Sprache der technischen Dokumentation einfach, sinnvoll und verständlich?
• Werden neue Begriffe oder Abkürzungen in der technischen Dokumentation erläutert?
• Werden reduzierte Regeln der Rechtschreibung (kontrollierte Sprache) eingesetzt?
• Ist der Text der technischen Dokumentation konsistent formuliert und gegliedert?
• Gibt es ein Inhaltsverzeichnis mit den Punkten der Gliederung?
• Ist die Gliederung der technischen Dokumentation sinnvoll und logisch?
• Ist das Inhaltsverzeichnis der technischen Dokumentation aktuell?
• Ist für die technische Dokumentation ein Stichwortverzeichnis erstellt worden?
• Sind die Seitenzahlen im Stichwortverzeichnis auf dem aktuellen Stand?
• Wird die technische Dokumentation durch geeignete Register unterteilt?
• Sind die Überschriften informativ formuliert?
• Sind Handlungsaufforderungen knapp formuliert?
• Ist die richtige Reihenfolge der Handlungsaufforderungen eingehalten?
• Ist die Länge der einzelnen Sätze in allen technischen Dokumenten begrenzt?
• Ist der Text der technischen Dokumentation gut lesbar?
• Sind die Schriftgrößen für alle Zeichen der Dokumentation normgerecht gewählt?
• Werden Hervorhebungen des Texts in allen Dokumenten einheitlich verwendet?
• Werden die Inhalte durch Abbildungen, Piktogramme und Symbole geeignet unterstützt?
• Werden gleiche Informationen durch gleiche Bildelemente unterstützt?
• Werden Farben funktional und konsistent verwendet?
• Werden Gefahrenhinweise nach einem eindeutigen Prinzip gestaltet?
• Sind alle Gefahrenhinweise in die technische Dokumentation aufgenommen worden?
• Werden die Farben für die Gefahrenstufen normgerecht verwendet?
• Wird in der technischen Dokumentation vor Missbrauch gewarnt?
• Können die Anwender mit Hilfe der Dokumentation alle Teile der Anlage sicher nutzen?
• Gibt es für die Bedienung der Anlage eine Kurzanleitung?
• Enthält die technische Dokumentation eine Telefonnummer für Rückfragen?
• Mit welcher Software wurde die technische Dokumentation erstellt?
• Kann die technische Dokumentation mit der Software problemlos geändert werden?
• Lässt sich die technische Dokumentation mit der Software in andere Sprachen übertragen?
• Ist ein geeignetes Ausgabemedium gewählt worden (PDF, Online-Hilfe)?
|
