Redaktionsprozess für die Technische Dokumentation

Wir arbeiten auf der Grundlage unseres bewährten Redaktionsprozesses. Dadurch können wir Kosten zuverlässig kalkulieren und die bestmögliche Qualität erreichen. Gerne arbeiten wir auch nach den Redaktionsprozessen, die Sie in Ihrem Unternehmen bereits erfolgreich etabliert haben.
Ingenieurbüro Katzenmeier 2018, Alle Rechte vorbehalten

Im ersten Schritt führen wir ein Recherchegespräch mit Ihnen. Wir möchten dabei herausfinden, wie und von welcher Zielgruppe Ihr Produkt angewendet wird. Welche Unterlagen sind bereits vorhanden, welche werden noch benötigt? Mit diesen Informationen können wir den Umfang des Projekts abschätzen.

Anschließend erarbeiten wir in Absprache mit Ihnen das Dokumentationskonzept. Wir entwickeln Aufbau, Gliederung und Layout der Dokumentation. Dabei berücksichtigen wir gültige Normen und Richtlinien. Wir ermitteln ein passendes Informationsmodell, mit dem die Inhalte optimal strukturiert und standardisiert werden können.

Zunächst sammeln wir die benötigten Informationen. Fehlende Informationen recherchieren wir, in dem wir gezielte Fragen beispielsweise an Ihre Entwickler stellen.
Mit Hilfe dieser Informationen formulieren wir anschließend Texte und erstellen Illustrationen, z. B. für Beschreibungen, Handlungsanweisungen, Anwendungsbeispiele oder Hinweise. Dabei achten wir genau darauf, dass die Inhalte leicht verständlich und praxistauglich sind.

Wir lektorieren und überprüfen die Dokumentation nach dem Vier-Augen-Prinzip, bevor wir sie zum Korrekturlesen an Sie weiterleiten. Gemeinsam mit Ihnen führen wir das Review durch. Um die bestmögliche Qualität sicher zu stellen, lektorieren wir die Dokumentation ein weiteres Mal.

In agilen Softwareprojekten werden die Arbeitsschritte Erstellen, Prüfen und Korrigieren iterativ in sogenannten Sprints durchgeführt.

Gerne übernehmen wir für Sie das Übersetzungsmanagement.
Beim Erstellen der Dokumentation achten wir bereits darauf, dass der Inhalt übersetzungsgerecht und die Terminologie eindeutig und konsistent ist.

Wir publizieren Ihre Technische Dokumentation in das passende Format, z. B. ins Post-Script-Format für die Druckvorstufe, als kompilierte Online-Hilfe oder dynamisch im Content-Delivery-Portal.
Falls gewünscht, archivieren und pflegen wir Ihre Technische Dokumentation.