Technische Dokumentationen haben es in sich, sie müssen eine Vielzahl von Anforderungen erfüllen. Bei der Anfertigung in Eigenregie stoßen Laien schnell an ihre Grenzen, denn die gesetzlichen Vorgaben, Normen und Verbraucherschutzbestimmungen sind so komplex, dass man leicht den Überblick verlieren kann. Und hier kommt midok® ins Spiel. Liegen uns technische Dokumentationen vor, überprüfen wir diese auf Herz und Nieren.
Von A wie Analyse bis Z wie Zusammenfassen
Wir analysieren von Ihnen bereitgestellte Dokumente. Haben wir Schwachstellen aufgespürt, so teilen wir Ihnen notwendige Verbesserungen mit. Sie erhalten ein detailliertes Analyseprotokoll, in dem wir konkrete Vorschläge auflisten. Durch unsere Beurteilung sind Sie in der Lage, Änderungen in Eigenregie durchzuführen. Fehlen Ihrem Unternehmen die Kapazitäten, dann übernehmen wir die Umsetzung für Sie.
Technische Dokumentationen: für den Vertrieb unentbehrlich
Dokumente wie Betriebsanleitungen, Risikobeurteilungen und Co müssen sprachlich und stilistisch korrekt sein. Zudem gilt es, Inhalte leicht erfassbar und verständlich zu gestalten. So wird Nutzern die richtige Handhabung wesentlich erleichtert. Hinzu kommt, dass viele Vorschriften in Sachen Produktsicherheit und Verbraucherschutz einzuhalten sind. Die Dokumentationsanalyse verfolgt daher das Ziel, Daten, Abbildungen und Texte systematisch auszuwerten. Sie ermittelt die Qualität von technischen Abhandlungen. Außerdem stellt sie fest, ob in rechtlicher Hinsicht Widersprüche und Fehler bestehen.
Die Analyse umfasst die gesamte Dokumentation, auch die Formatierung und die Gliederung gehören dazu. Wir achten zudem auf redundante Bereiche. Diese lassen sich bei umfangreichen Dokumentationen kaum vermeiden, denn die Bestimmungen und Normen geben häufig die Inhalte vor. Dennoch führen Wiederholungen zu aufgeblähten Abhandlungen. Wo es sinnvoll ist, schlagen wir Formulierungen vor, bei denen der Rotstift zum Einsatz kommen kann. Wir prüfen auch die Platzierung und die Relevanz von technischen Illustrationen. Gleichzeitig erläutern wir, an welchen Stellen Inhalte zusammengefasst und kategorisiert werden können. Darüber hinaus liefert die Analyse Informationen darüber, ob es sich um Texte handelt, die leicht übersetzbar sind. Sätze lassen sich mitunter so arrangieren, dass es bei der automatischen Übersetzung nicht zu Fehlern kommt.
Quelle: Midjourney. Die schönsten Illustrationen nutzen nichts, wenn sie nicht zur Anleitung passen
Konformität der Technischen Dokumentationen
Jede Dokumentationsanalyse führen wir akribisch durch. Wir prüfen die Konformität mit Richtlinien, Gesetzen und Normen, die Übereinstimmung mit branchenspezifischen Vorgaben ist garantiert. Bei der Analyse von Gebrauchsanleitungen bildet die Norm DIN EN 82079-1 die Basis, bei Maschinen greift hingegen der Anhang VII A Nr. 1a der Maschinenrichtlinien.
Auf unserer To-do-Liste steht auch die Überprüfung von Querverweisen. Es spielt keine Rolle, ob diese vereinzelt oder in großen Mengen vorkommen. Selbst die Quellenkritik steht im Fokus, wobei wir die Echtheit der angegebenen Quellen überprüfen.
Unser Angebot für Sie
Sie sehen: Wir sind der erfahrene Dienstleister für alle Bereiche rund um die Technische Dokumentation. Die Dokumentationsanalyse stellt jedoch nur einen Zwischenschritt dar. Bis zur fertigen Risikobeurteilung, Betriebs- oder Bedienungsanleitung kommen zahlreiche Aufgaben hinzu. Es gilt, technische Abhandlungen userfreundlich und im Einklang mit Normen und gesetzlichen Bestimmungen zu gestalten.
Beauftragen Sie midok® mit der Konzeption, dürfen Sie auf fachkompetente Redakteure mit bedeutendem Praxiswissen zählen. Sie gehen mit uns auf Nummer sicher, denn wir beziehen bei der Arbeit Gesetzesänderungen und Aktualisierungen ein.
