Technische Dokumentation erstellen?

Technische Dokumentation ist der Oberbegriff für die Dokumentation eines Produkts. Der Begriff wird in erster Linie mit den Dokumenten und Informationen in Verbindung gebracht, die der Hersteller an die Öffentlichkeit übermittelt. Technische Dokumentation umfasst:

• Benutzeranweisungen
• Bedienungsanweisungen
• Service-Anweisungen
• Installationshandbücher
• Software Handbücher
• Online-Hilfe
• ...

tekom, der „Deutsche Fachverband für Technische Kommunikation und Informationsdesign“ wählt eine breitere Definition:

Der Begriff „Technische Dokumentation“ bezeichnet verschiedene Dokumente mit produktbezogenen Daten und Informationen, die für verschiedene Zwecke verwendet und gespeichert werden. „Verschiedene Zwecke“ bedeutet: Produktdefinition und -spezifikation, Gestaltung, Fertigung, Qualitätssicherung, Produkthaftung, Produktpräsentation; Beschreibung der Eigenschaften, Funktionen und Schnittstellen; beabsichtigter, sicherer und ordnungsgemäßer Gebrauch; Service und Reparatur eines technischen Produkts sowie dessen sichere Entsorgung.

Diese breitere Sicht, bei der alle während des gesamten Produktlebenszyklus erstellten Dokumente als Teil der technischen Dokumentation betrachtet werden, ist sicherlich gerechtfertigt. Das Ziel ist es schließlich, das technische Fachwissen und den Produktverlauf für spätere Nutzer der Informationen zugänglich zu machen (z. B. Ingenieure oder Betreiber, Patentanwälte oder auf Produkthaftung spezialisierte Strafverfolgungsbehörden).

Dienstleister im Bereich der technischen Dokumentation legen ihren Schwerpunkt jedoch in erster Linie auf Dokumente, die nach dem Produktionsprozess benötigt werden – von Vertriebsmitarbeitern, Systemintegratoren, Montagearbeitern, Betreibern, Servicetechnikern, Entsorgungsunternehmen usw.

Die Gründe sind einfach: Große Anforderungen an die Verständlichkeit und Unmissverständlichkeit der Dokumente (für die spezifische Zielgruppe), graphische Gestaltung, Einhaltung von Normen/ Richtlinien/ Gesetzen, sprachliche Korrektheit usw.
Die Dokumente werden veröffentlicht, d. h. sie sind Teil der öffentlichen Präsentation eines Herstellers.
Bei der Gestaltung der Dokumente sind in der Regel relativ wenige herstellerspezifische Kenntnisse und Fachwissen – insbesondere keine Betriebsgeheimnisse – erforderlich. Stattdessen benötigt man viel Erfahrung mit den Werkzeugen und Zielmedien, was im Falle einer Online-Publikation wie einem Hilfesystem (WinHelp, HTMLHelp, JavaHelp oder eine „einfache“ DHTML-Hilfe) besonders deutlich wird.

Diese Kombination aus erforderlichem Grundwissen, Erfahrungen mit der Erfüllung der Anforderungen und dokumentationsspezifischer Fachkenntnisse – ein „absolutes Muss“, wenn Sie die Argumente für das oben genannte Outsourcing prüfen – steht mit einem besonderen Berufsstand bereit: dem Technischen Autor oder dem Technischen Redakteur. Diese Experten sind die Vermittler zwischen dem Hersteller/Konstrukteur und dem Entscheidungsträger/ Benutzer, egal ob im Unternehmen oder als Dienstleister.

Wir bei INSTRKTIV bevorzugen den allgemeineren Begriff „Technische Kommunikation“ statt „Technische Dokumentation“, weil er den Umfang unserer Dienstleistungen präziser umreißt.

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Accusamus deserunt fugit illum ipsam laudantium maiores nam nemo odit perspiciatis quibusdam, velit vero voluptatibus. Esse inventore non nostrum porro possimus rerum.

Um eine rechtssichere, optisch ansprechende und benutzerfreundliche technische Dokumentation zu erstellen, wird der INSTRKTIV 5-Phasen-Anleitungsprozess befolgt, der folgende Phasen aufweist:

Phase 1: Gesetzgebung

• Analyse der anzuwendenden (CE-) Richtlinien und harmonisierten Normen
• Festlegung der Anforderungen für die Anleitungen
• Zusammenstellung einer Checkliste mit den Anforderungen
• Schreiben der rechtlichen Texte

Phase 2: Inhaltlicher Entwurf

• Ermittlung sämtlicher Produktinformationen
• Schreiben und Redigieren der Texte
• Zusammenstellung eines ersten inhaltlichen Entwurfs
• Prüfung durch den Auftraggeber

Phase 3: Inhaltlicher Entwurf (Bild)

• Erstellung von Illustrationen
• Zusammenstellung eines zweiten inhaltlichen Entwurfs
• Prüfung durch den Auftraggeber
• Besprechung und Optimierung
  Freigabe durch den Auftraggeber

Phase 4: Entwicklung des Templates

• Festlegung der Aufmachung und Darstellung auf Grundlage der Corporate Identity
• Entwicklung des Templates und der Stylesheets
• Besprechung mit Auftraggeber
• Optimierung

Phase 5: Output-Erstellung

• Übersetzung
• DTP-Arbeiten
• Prüfung durch den Auftraggeber
• Besprechung und Optimierung

Für jeden Kunden und jedes Problem ist ein individueller Ansatz erforderlich. Der folgende Arbeitsablauf versucht jedoch den allgemeinen Prozess aufzuzeigen, mit dem wir optimale Ergebnisse für die technische Dokumentation unserer Kunden erzielen.

Treffen
Sie suchen nach einer Lösung, um Ihre Handbücher oder Ihre technische Dokumentation zu erstellen. Nach einem ersten gemeinsamen Gespräch bieten wir den ersten Schritt in Richtung einer Lösung. Wir entscheiden, wie wir unsere Kenntnisse und unser Fachwissen anwenden können oder greifen auf unser Netzwerk aus Fachleuten zurück, das Sie bei dem Erreichen Ihrer Ziele unterstützt.

Planung
Sie möchten verstehen, wie INSTRKTIV Probleme lösen kann. Gemeinsam werden wir den Umfang bestimmen und unsere gegenseitigen Erwartungen diskutieren. Sie erhalten einen Projektplan, der ein Budget und einen Zeitplan umfasst. Darin erfassen wir auch sorgfältig die Arbeitsschritte auf dem Weg zu Ihrer individuellen Lösung. Unabhängig davon, ob diese Lösung Ihnen Tipps gibt, wie Sie Ihre Risiken eindämmen, Ihr Benutzerhandbuch entwickeln oder bei der Einrichtung Ihres Dokumentationsprozesses Back-up-Support leistet.

Ausführung
Sie möchten über den Fortschritt informiert bleiben. Wir arbeiten eng mit Ihnen zusammen, um das Endergebnis zu erreichen. Da Sie am Ende jeder Entwicklungsstufe in den Prozess einbezogen werden, bleiben Sie auf dem Laufenden und können jeweils zum richtigen Zeitpunkt Einfluss nehmen. Während des Prozesses werden Sie Fortschrittsdokumente erhalten, wie z. B. einen Recherchebericht, eine Übersicht des inhaltlichen Designs und die Vorlage mit dem Look&Feel des druckfertigen Handbuchs.

Umsetzung
Sie möchten eine reibungslose Umsetzung der von uns bereitgestellten Lösung. Wir bieten immer Lösungen an, die sofort umgesetzt werden können. Dies kann eine Empfehlung sein, um die vorhandene Dokumentation zu verbessern, die Erstellung eines druckfertigen Handbuchs oder einer Software, die Ihre Mitarbeiter sofort einsetzen können.

In Kontakt bleiben
Sie brauchen einen langfristigen Partner, um Ihre Handbücher und technische Dokumentation zu entwickeln und zu verwalten. Wir stehen jederzeit bereit, um Sie schnell und professionell zu beraten. Auf Wunsch halten wir Sie über alle neuen Entwicklungen – einschließlich geänderter Gesetze und Vorschriften – auf dem Laufenden.

FORDERN SIE DIREKT EIN ANGEBOT AN