Dokumente
Übersicht
Sie glauben, dass Ihre Dokumente nicht ideal sind, wissen aber nicht, wie sie verbessert werden können? Sie sind unsicher, ob Ihre Betriebsanleitungen die gesetzlichen Anforderungen erfüllen? Oder sie brauchen Unterstützung bei der Neukonzipierung Ihrer Dokumentationen? Lesen Sie, wo wir Sie beraten können:
Warum Dokumente optimieren?
Dokumente sollten nützliche Werkzeuge für den Anwender sein und gerne gelesen bzw. benutzt werden, also problemlos funktionieren. Manchmal tun sie das nicht. Dies kann unterschiedliche Gründe haben:
- Unverständlicher Text, schlechte Übersetzung – der Anwender versteht nicht, muss nachfragen
- Fehlende oder ungenügende Sicherheitshinweise – der Anwender schädigt das Produkt oder sich selbst
- Unvollständigkeit der Dokumentation – der Anwender findet nicht das, was er benötigt, muss nachfragen
- Fehlerhaftigkeit der Dokumentation – der Anwender kann nicht weiterarbeiten, muss nachfragen
- Schlechte Inhaltsstruktur – der Anwender muss immer wieder neu suchen, ist genervt
Alle diese Gründe verursachen Ihrem Unternehmen meist hohe Kosten, z.B. im Bereich des Kundensupports. Wir glauben, das muss nicht sein!
Was ist unser Inhaltskonzept?
Korrekter Inhalt, klare Struktur und Darbietung tragen entscheidend dazu bei, dass der Anwender mit Ihrem Produkt richtig und sicher umgehen kann. Unser Inhaltskonzept lautet deshalb Standardisierung. Dies bedeutet:
- methodisch strukturierter Text
- modulare Dokumente
- normierte Sprache
- zielgruppengerechter Inhalt
Für uns steht eine effektive Benutzbarkeit der Dokumente im Mittelpunkt. Daher sind die Themen Ergonomie und Usability wichtige Bausteine unseres Inhaltskonzepts. Mit ARAKonzept zeigen wir Ihnen, wie dies gelingt.
Darüber hinaus spielen Normen und Richtlinien eine entscheidende Rolle in der Erstellung von technischer Dokumentation. Eine mangelhafte Betriebsanleitung etwa wird heute als ein Produktmangel angesehen. Ein durchgendes Konzept für Sicherheitskapitel und Sicherheitshinweise ist daher ebenfalls integraler Bestandteil unseres Inhaltskonzepts in ARAKonzept.
Welche Ergebnisse liefert unsere Beratung?
Unsere Beratung liefert Ihnen:
- Betriebsanleitungen, Benutzerinformationen, Bedienungsanleitungen, etc., die nicht nur im Schrank stehen – sondern die Ihr Kunde benutzt und die darüber hinaus den gesetzlichen Vorgaben (Normen und Richtlinien) entsprechen und daher zur Produktsicherheit beitragen
- Online-Hilfen und Softwarehandbücher, die dem Anwender wirklich helfen – der Anwender wird befähigt, nicht bloß informiert
Unsere Grundlagen
Unsere Grundlagen basieren auf
- langjähriger Erfahrung in der technischen Dokumentation, auch mit großen Projekten
- detaillierter Kenntnis von Normen und Richtlinien
- der kognitiven Psychologie – Wahrnehmung und Gestaltpsychologie
- der Sprech-Akt-Theorie
Wie gehen wir bei unserer Beratung vor?
Folgende Schritte führen uns gemeinsam zu optimalen Dokumenten:
- Analyse Ihrer vorhandenen Texte und Dokumente (z.B. Betriebsanleitungen, Benutzerinformationen, etc.) hinsichtlich
- Vollständigkeit des Inhalts, aber auch hinsichtlich überflüssiger Inhalte – steht das drin, was der Anwender wissen muss, aber auch nur das?
- Verständlichkeit des Inhalts – befähigt die Dokumentation den Anwender, mit dem Produkt umzugehen?
- Struktur und Ordnung der Dokumente – kann der Anwender schnell finden, was er sucht?
- Konformität mit Normen und Richtlinien – Rechtssicherheit
- gemeinsames Herausarbeiten Ihrer Anforderungen und Festlegen von weiteren Projektschritten
- Abarbeiten der Projektschritte, z. B. Basis-Schulung, Workshops
- Erstellung Ihres eigenen Redaktionsleifadens, der folgendes enthält:
- die Zielgruppen- und Zweckdefinition der Dokumentation
- alle relevanten Normen und Richtlinien
- die Standardstrukturen der Dokumente
- die Gestaltung der Dokumente
- Inhaltsvorlagen und Muster
Möchten Sie mehr wissen?
Auf den folgenden Seiten finden Sie weiterführende Informationen:
Bereich Querverweis Beratung ARAKonzept Wissensportal Standardisierungsmethoden Wissensportal Normen & Richtlinien
