INSTRKTIV: Dienstleister Technische Dokumentation

Sie denken, dass Ihre Dokumentation nicht alle rechtlichen Anforderungen erfüllt? Sie möchten sicher gehen, dass Ihre Nutzer Ihr Produkt sicher anwenden können? Sie verfügen über ungenügende Kapazität, um Ihre Dokumentation vor der Markteinführung fertig zu stellen? Sie möchten die Nutzererfahrung Ihrer Dokumentation verbessern? Sie denken, Sie können Kosten durch bessere Kommunikation und besseres Dokumentations-Management sparen?

Also, wenn Sie Ihre Dokumentation auf die nächste Ebene heben wollen, dann ist INSTRKTIV der Dienstleister für Technische Dokumentation, den Sie brauchen!

FORDERN SIE DIREKT EIN ANGEBOT AN


Wie Ihnen INSTRKTIV’s Technische Dokumentations- Leistungen helfen, Ihr Unternehmen wachsen zu lassen

Eine gut durchdachte und klare Bedienungsanleitung trägt zu der positiven Wahrnehmung Ihres Produktes bei. Zusätzlich werden klare Anweisungen die Nutzer Ihres Produktes vor jeglichen Restrisiken warnen, was wiederum Ihre Haftbarkeit reduziert.

Als ein Dienstleister für Technische Dokumentation glauben wir, dass:

  • Sie nach all den Anstrengungen, die Sie als eine Firma in die Entwicklung eines guten Produktes und eine gute Vermarktung gesteckt haben, ganz sicher nicht möchten, dass es für Ihren Kunden eine negative Erfahrung ist, wenn er die Bedienungsanleitung zu Rate zieht!
  • Benutzer in dem Moment Produktinformationen griffbereit haben möchten, wenn sie sie benötigen. Wenn man lediglich ein Papierhandbuch hat, wie von der CE Kennzeichnung vorgeschrieben, um die Europäischen Richtlinien einzuhalten, wird dieses Bedürfnis nicht befriedigt.
  • Eine gute Dokumentation Ihre Haftbarkeit reduzieren und die Sicherheit Ihres Produktes verbessern kann, während die Kosten reduziert werden.

 

Suchen Sie nach einem Handbuch, das alle rechtlichen Anforderungen erfüllt? Ein leicht zu lesendes und benutzerfreundliches Dokument, das Ihre Firma oder Marke vervollständigt? Suchen Sie nach zusätzlicher Kapazität, um Ihre Dokumentation rechtzeitig fertig zu stellen? Dann möchten Sie INSTRKTIV als Ihren Dienstleister für Technische Dokumentation haben. INSTRKTIV bietet Ihnen Rat und Unterstützung für die Entwicklung Ihrer Handbücher oder erstellt diese für Sie.

Unser Ablauf

Um zur rechtssicheren, optisch ansprechenden und benutzerfreundlichen Anleitungen zu gelangen, wird der INSTRKTIV 5-Phasen-Anleitungsprozess befolgt, der in folgende Phasen unterteilt wird:

Im ersten Schritt werfen wir einen Blick auf die Gesetzgebung. Wir analysieren die anzuwendenden (CE-) Richtlinien und harmonisierten Normen. Daraufhin werden die Anforderungen für die Anleitung festgelegt und eine Checkliste mit diesen Anforderungen erstellt. Anschließend wird dann der rechtliche Text verfasst.

Im zweiten Schritt geht es um den inhaltlichen Entwurf. Wir ermitteln sämtliche Produktinformationen und schreiben bzw. redigieren die Texte. Daraufhin erfolgt die Zusammenstellung eines ersten inhaltlichen Entwurfes, welcher vom Auftraggeber geprüft wird.

Beim dritten Schritt beschäftigt man sich mit dem inhaltlichen Entwurf (Bild). Es werden Illustrationen erstellt und ein zweiter inhaltlicher Entwurf verfasst. Diesen prüft dann der Auftraggeber und nach der Besprechung und Optimierung erfolgt die Freigabe durch diesen.

Im vierten Schritt erarbeitet man das Template. Die Aufmachung und die Darstellung auf Grundlage der Corporate Identity werden festgelegt. Basierend hierauf werden das Template und die Stylesheets entwickelt. Nach der Besprechung mit dem Auftraggeber erfolgt ggf. eine Optimierung.

Beim letzten Schritt handelt es sich um die Output-Erstellung. Es erfolgen Übersetzungen und DTP-Arbeiten. Diese werden anschließend wieder durch den Auftraggeber geprüft und daraufhin besprochen und ggf. optimiert.

Wie wir als ein Dienstleister für Technische Dokumentation mit Ihnen arbeiten

Jeder Kunde und jedes Problem bedarf einem eigenen Ansatz. Mit dem folgenden Ablaufplan möchten wir dennoch versuchen, Ihnen den allgemeinen Prozess darzustellen, den wir eingeführt haben, um die besten Ergebnisse für unsere Kunden als Dienstleister für Technische Dokumentation zu erlangen.

Zusammentreffen
Sie suchen nach einem Dienstleister für Technische Dokumentation und einer Lösung, Ihre Bedienungsanleitung oder technische Dokumentation zu erstellen. Nach einer vorausgehenden Besprechung bieten wir einen ersten Schritt in Richtung einer Lösung. Wir denken über die Wege nach, mit denen wir unser Wissen und unsere Expertise anwenden können oder wie wir uns unser Netzwerk von Experten zu Nutze machen können, um Ihnen dabei behilflich zu sein, Ihre Ziele zu erreichen. Sie werden eine Email mit einer klaren Formulierung der Herausforderungen zusammen mit einigen ersten Ratschlägen erhalten.

Planung
Sie möchten verstehen, wie INSTRKTIV in der Lage ist, das Problem zu lösen. Zusammen werden wir den Umfang bestimmen und unsere gemeinsamen Erwartungen diskutieren. Sie werden einen Projektplan erhalten, der ein Budget und einen Zeitplan beinhaltet, in dem wir sorgfältig die benötigten Schritte bestimmen, um die Lösung zu erreichen. Unabhängig davon, ob diese Lösung Ihnen einen Rat gibt, wie Sie Ihre Risiken reduzieren können, Ihre Bedienungsanleitung entwickeln oder Sicherungs-Unterstützung für das Aufstellen Ihres Dokumentations-Prozesses bieten.

Ausführung
Sie möchten über den Ablauf informiert bleiben. Wir arbeiten eng mit Ihnen zusammen, bis wir das Endergebnis erreicht haben. Denn Sie werden im gesamten Ablauf am Ende jeden Schrittes involviert sein, Sie werden informiert bleiben und Sie sind in der Lage im richtigen Moment Einfluss auszuüben. Während des Prozesses werden Sie Dokumente über den Fortschritt erhalten, wie z.B. ein Recherchebericht, eine Bereitstellung des Content Designs und das Template mit dem Look and Feel des druckbaren Handbuches.

Umsetzung
Sie möchten eine fehlerfreie Umsetzung der Lösung durch uns. Wir bieten immer Lösungen, die sofort angewendet werden können. Dies kann eine Empfehlung sein, eine bestehende Dokumentation zu verbessern, die Erstellung eines druckbaren Handbuches oder eine Software, die Ihre Angestellten direkt einsetzen können.

In Kontakt bleiben
Sie suchen einen langfristigen Partner für die Entwicklung und Verwaltung Ihrer Handbücher und technischen Dokumentationen. Wir stehen Ihnen immer zur Verfügung, um Ihnen mit sofortigem und professionellem Rat zur Seite zu stehen. Wenn Sie möchten, halten wir Sie über jede neue Entwicklung, einschließlich Änderungen in Gesetzen und Anforderungen, informiert. 

Weitere Informationen

Technische Dokumentation begleitet das Produkt, um dessen Nutzung, etwa die eines Gerätes, einer Maschine oder Anlage, zu erläutern. Ziel der Dokumentation ist die Sicherstellung der ordnungsgemäßen, aber vor allem auch sicheren Nutzung des Produkts. Häufig ist die Bereitstellung der Dokumentation obligatorisch; meist im Rahmen der CE-Kennzeichnung. Die CE-Kennzeichnung ist eine Selbstzertifizierung des Herstellers, dass sein Produkt die entsprechenden europäischen Richtlinien erfüllt. Diese Richtlinien enthalten häufig auch Vorgaben für die Bereitstellung von technischer Dokumentation: Sie verpflichten den Hersteller, die erforderlichen Informationen zur sicheren Nutzung mitzuliefern. Auch wenn keine Richtlinien für das Produkt gelten, kann es aus Sicht der Produkthaftung sinnvoll sein, dem Produkt eine technische Dokumentation beizufügen. Dies können Sie selbst tun oder dafür einen Dienstleister beauftragen.

Was muss die Dokumentation enthalten?

Bei der Entwicklung technischer Dokumentationen richten wir uns als Dienstleister immer nach den Anforderungen der Richtlinien. Mitunter können die Richtlinien sehr spezifisch sein. Beispielsweise erfordert eine der vielen Anforderungen der Maschinenrichtlinie (2006/42/EG) die Angabe, „welche Inspektionen und Wartungsarbeiten in welchen Abständen aus Sicherheitsgründen durchzuführen sind“. Eine weitere Anforderung ist die Angabe, „welche Teile dem Verschleiß unterliegen“. Häufig formulieren die Richtlinien jedoch auf einem etwas höheren Abstraktionsniveau. Beispielsweise steht in der Richtlinie für Gasverbrauchseinrichtungen (90/396/EWG), dass „die Bedienungs- und Wartungsanleitung für den Benutzer [...] alle für eine sichere Benutzung erforderlichen Angaben enthalten [...] [muss]“. Im Grunde besagt die Richtlinie also, dass dem Produkt eine ordentliche technische Dokumentation beiliegen muss.

Eine Möglichkeit, Richtlinien umzusetzen, ist die Einhaltung von Normen. Im Bereich der technischen Dokumentation gibt es die Norm IEC 82079-1 der Internationalen Elektrotechnischen Kommission. Diese Norm ist die Nachfolgerin der EN 62079 aus dem Jahre 2001 und wird von den meisten Dienstleistern im Bereich technische Dokumentation verwendet. Die Fassung in deutscher Sprache für Deutschland erschien als DIN EN 82079-1 im Juni 2013. Sie enthält detaillierte Mindestanforderungen an den Inhalt und die Gestaltung von Gebrauchsanleitungen. Zudem sind beispielsweise Aspekte wie grafische Symbole, Dokument- und Produktkennzeichnung, Risikobeurteilung und –minderung, Ergonomie und spezielle Zielgruppen enthalten. Die Norm IEC 82079-1 ist wie folgt gegliedert:

1. Anwendungsbereich
2. Normative Verweisungen
3. Begriffe
4. Prinzipien
5. Inhalt von Gebrauchsanleitungen
6. Präsentation von Gebrauchsanleitungen
7. Bewertung der Konformität mit diesem Teil der Normenreihe 82079
8. Bewertung der Gebrauchsanleitung
9. Checkliste für Konformität und Kommentare
10. Checkliste für die Wirksamkeit der Kommunikation
11. Planung der Vorbereitung einer Gebrauchsanleitung
12. Empirische Methoden zur Unterstützung der Vorbereitung von Gebrauchsanleitungen

Was zeichnet eine gute technische Dokumentation aus?

Wir der Auffassung, dass außer der Entwicklung einer präzisen, korrekten und umfassenden technischen Dokumentation einige weitere Aspekte besonderer Aufmerksamkeit bedürfen: Zielgruppe, Illustrationen und weitere Medien, die den Nutzer optimal unterstützen, die Informationen aufzunehmen.

Zielgruppenspezifische Kommunikation

Ansprechende Kommunikation in der technischen Dokumentation, also die Produktdokumentation, ist äußerst wichtig. Es ist die Kunst, der Zielgruppe Fakten und Informationen präzise und effektiv zu vermitteln. Darüber hinaus ist es essenziell, der Sprache mächtig zu sein, in der die technische Dokumentation erstellt wird. Zudem ist es entscheidend, die Zielgruppe genau zu kennen. Jeder Nutzerkreis besitzt unterschiedliche Eigenschaften, etwa in Bezug auf Alter, Wissensstand, Sprachkompetenz, Bildungsniveau und Geschlecht. Eine technische Dokumentation kann sich an einen Verbraucher, Monteur oder Wartungstechniker richten. Auch die einzelnen Nutzergruppen sind heterogen. Denn ein Monteur kann wiederum ein Monteur eines Treibhauses, einer Wasseraufbereitungsanlage oder des Internetfernsehens sein.

Bei der Erstellung einer technischen Dokumentation müssen meist mehrere Fachleute konsultiert werden, um alle entsprechenden Produktinformationen zu erhalten. Dies können unter anderem Fachleute im Bereich Mechanik, Elektronik, Ingenieurswesen, Installationstechnik, Software, Bedienoberfläche, Gewährleistungsvorschriften oder interne Kommunikation sein. Die von den Fachleuten stammenden Informationen müssen dann für die entsprechende Zielgruppe in verständliche Sprache umgewandelt werden. Ansätze wie Simplified Technical English und Minimalismus können diesen Prozess bei gegebenem Mehrwert unterstützen.

Wir sind der Auffassung, dass jede technische Dokumentation, ungeachtet der Zielgruppe, auf den Punkt und so kurz wie möglich formuliert sein muss. Technische Dokumentation muss vom Nutzer möglichst wenig Anstrengung erfordern, um die Informationen aufzunehmen. Zudem muss technische Dokumentation leicht verständlich sein. Besondere Aufmerksamkeit gilt den Gliederungsüberschriften von Kapiteln und Abschnitten sowie Einführungen, damit die Informationen so effektiv wie möglich ihren Weg zum Nutzer finden. Visuelle und textuelle Inhalte müssen einander unterstützend ergänzen. Produktinformationen, Technologie und Eigenschaften müssen in verständliche Anweisungen übersetzt werden. Beispiele und Szenarien sorgen dafür, dass der Nutzer Informationen effektiver aufnimmt. Zu guter Letzt muss die technische Dokumentation einen warmen, zugänglichen und angenehmen Eindruck machen.

Illustrationen

Ein Bild sagt mehr als 1000 Worte. Das gilt sicher auch für Abbildungen in einer technischen Dokumentation. Abbildungen können die Funktion eines Produktes oder einer Handlung effektiver erläutern als Text. Illustrationen verkürzen die Zeit, etwas zu lernen, und sorgen dafür, dass die Aufmerksamkeit des Nutzers besser aufrechterhalten wird. Illustrationen tragen zur oben erwähnten warmen, zugänglichen und angenehmen Aufmachung der technischen Dokumentation bei. Sie schaffen Lebendigkeit und Farbe. Im Rahmen der Internationalisierung ist Folgendes besonders wichtig: Alles, was durch eine Illustration erläutert wird, muss nicht übersetzt werden. Die Tatsache, dass einer Studie der Universität Hamburg zufolge im Jahr 2011 mehr als 7,5 Millionen Erwachsene in Deutschland funktionale Analphabeten waren, also nicht gut lesen können, betont noch einmal den Mehrwert von Illustrationen.

Weitere Medien

Aufgrund der Vorschriften ist es im Prinzip obligatorisch, Produkten technische Dokumentation als gedrucktes Dokument beizulegen. Es gibt jedoch häufig bessere Möglichkeiten, dem Nutzer Produktinformationen näher zu bringen als in gedruckter Form. Beispielsweise ist es meist praktischer, einen QR-Code zu scannen, mit dem sich eine App oder ein Browser mit Produktinformationen öffnet, als die gedruckte Fassung in jenem Moment suchen zu müssen. Ein weiteres Medium, dessen Einsatz weiterhin exponentiell zunimmt, ist das Video.


Fordern Sie direkt ein Angebot an!

Fordern Sie ein Angebot an