Dokumentation
Technische Handbücher, Betriebsanleitungen, Software-Dokumentation und Online-Hilfen
Ihre Dokumente
- Produkte brauchen eine klare und leicht verständliche Dokumentation, die alle gültigen Normen und Vorschriften erfüllt.
- Ich habe mich auf Technische Handbücher, Betriebsanleitungen, Software-Dokumentation und Online-Hilfen spezialisiert.
Projektionsschritte
Bei der Erstellung Ihrer Dokumentation gehen wir nach folgendem Schema vor:
- Planung des Konzepts der Dokumentation, Auswertung des verfügbaren Referenzmaterials, Vorführung des zu beschreibenden Geräts, der Maschine oder der Software
- Redaktion der Dokumentation und fortlaufende Klärung der technischen Fragen
- Ausarbeitung des Entwurfs mit Zeichnungen und Bildern zur Prüfung
- Einarbeitung von Korrekturen und Änderungen
- Freigabe des Dokuments (Online-Publizierung oder Start des Druckprozesses) und evtl. Beginn der Übersetzung
Zielsetzung
Bei der Erstellung achten wir darauf, dass die Dokumentation folgende Kriterien aufweist:
- Klarheit (Verwendung eindeutiger Begriffe, nachvollziehbare Abläufe)
- Verständlichkeit (knapper Stil, kurze Sätze, logische Handlungsfolgen)
- Normengerechtigkeit (Normen und Vorschriften werden berücksichtigt)
- und Übersetzungstauglichkeit (optimierte Texte für den Einsatz von Übersetzungstechnologien)