Qualitätssicherung
Bevor wir eine Dokumentation ausliefern, wird sie von mehreren Mitarbeitern der D.O.G. GmbH gegengelesen. Das Lektorat kann dabei auf intern entwickelte Tools zurückgreifen und dadurch einen sehr hohen Qualitätsstandard gewährleisten. Wir prüfen verschiedene Aspekte der Dokumentation, u. a.:
Rechtliche Aspekte:
- Einhaltung der relevanten Normen und Vorschriften wie die Maschinenrichtlinie.
- Anbringung von Warnhinweisen.
Sprachliche Aspekte:
- Kurze, verständliche Sätze.
- Einhaltung der Terminologie.
- Logische Reihenfolge der Handlungen.
Fachliche und inhaltliche Aspekte:
- Korrektheit des Inhalts. Übereinstimmung mit der Spezifikation, Korrektheit der Zahlen.
Usability Aspekte:
- Berücksichtigung des Kenntnisstandes des Lesers.
- Verwendung von Beispielen, aussagekräftigen Überschriften, Erläuterung von Fachausdrücken und Abkürzungen,
- Verwendung von Bildern, Orientierungshilfen, Suchmöglichkeiten.
Technische Aspekte:
- Verlinkungen, Codierung von Sonderzeichen, Textlänge, Programmversion.
Qualität ist Teamarbeit. Durch einen regelmäßigen Austausch zwischen Ihnen und unseren Redakteuren, lässt sich die Qualität dauerhaft verbessern.
Aktuelles
Kurz-Check Ihrer Dokumentation
Schicken Sie uns eine Bedienungsanleitung. Sie erhalten eine Kurzanalyse mit einer Auflistung der festgelegten Mängel und des Optimerungspotentials für einen Pauschalpreis von 150,- Euro (zzgl. MwSt.).
Fachinformation
Abkürzen, aber richtig!
Ohne sie kommt die technische Dokumentation oder die Software nicht aus. Abkürzungen sind aus dem Alltagsleben eines Redakteurs kaum wegzudenken und sorgen dennoch für viel Gesprächsstoff.
Redaktionsleitfaden: Was gehört dazu?
Einen Redaktionsleitfaden zu erstellen ist zuerst einmal viel Arbeit. Nach vielen Besprechungen und Arbeitsstunden entsteht ein Dokument von 10 bis zu über 400 Seiten. Es regelt die Arbeit der technischen Redakteure.