Dokumentoptimierung

Sie glauben, dass Ihre Dokumente nicht ideal sind – wissen aber nicht, wie Sie sie verbessern können? Sie sind unsicher, ob Ihre Betriebsanleitungen die gesetzlichen Anforderungen erfüllen? Oder brauchen Sie Unterstützung beim Neuaufbau Ihrer Dokumentationen? Sie möchten Ihre Grafiken in der Darstellungsart optimieren oder die Grafiken günstiger erstellen?

Erfahren Sie hier, wie wir Sie beraten können.

Warum Dokumente inhaltlich 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.

Gründe, warum Dokumente nicht funktionieren:

  • Die Texte sind unverständlich und schlecht übersetzt: Die Anwender verstehen die Inhalte nicht und fragen bei Ihnen nach.
  • Die Sicherheitshinweise fehlen oder sind ungenügend: Die Anwender schaden sich selbst oder beschädigen das Produkt.
  • Die Dokumentation ist unvollständig: Die Anwender finden nicht was sie benötigen und fragen bei Ihnen nach.
  • Die Dokumentation ist fehlerhaft: Die Anwender können nicht weiterarbeiten und müssen nachfragen.
  • Die Inhalte sind schlecht strukturiert: Die Anwender suchen immer wieder neu und sind genervt.

Alle diese Gründe verursachen Ihrem Unternehmen meist hohe Kosten, z. B. im Bereich des Kundensupports. Wir glauben, dass das nicht sein muss!

Warum Grafiken optimieren?

Grafiken oder technische Illustrationen unterstützen die Texte. Oder sie ersetzen sie manchmal ganz. Deshalb ist es wichtig, klare Definitionen für die Grafikerstellung zu haben. Dadurch wirken die Illustration einheitlich, und die Anwender können die Informationen besser verstehen.

Für funktionierende Grafikstile benötigen Sie klare Stilkonzepte.

Dafür legen wir Folgendes fest:

  • Illustrationsarten und Grafikstile
  • Vorlagen (Hardware, Foto, CAD-Grafik)
  • Benötigte Maßstäbe und Perspektiven
  • Linienarten und -stärken, Farben und Farbverläufe
  • Maßlinien, Bezeichnungen und Texte
  • etc.

Mit diesen Festlegungen können Sie Ihre Grafken effektiver und günstiger erstellen.

Unser Inhaltskonzept

Korrekter Inhalt, klare Struktur und Darbietung tragen entscheidend dazu bei, dass der Anwender mit Ihrem Produkt richtig und sicher umgehen kann. Darum setzen wir auf Standardisierung.

Die Komponenten unseres Inhaltskonzepts sind:

  • methodisch strukturierter Text
  • modulare Dokumente
  • normierte Sprache
  • zielgruppengerechter Inhalt

Für uns steht die effektive Benutzbarkeit der Dokumente im Mittelpunkt. Daher sind 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 gilt heute als ein Produktmangel! Ein durchgehendes Konzept für Sicherheitskapitel und Sicherheitshinweise ist daher ebenfalls integraler Bestandteil unseres Inhaltskonzepts.

Die Ergebnisse unserer Beratung

Unsere Beratung liefert Ihnen die folgenden Ergebnisse:

  • Betriebsanleitungen, Benutzerinformationen, Bedienungsanleitungen etc., die nicht nur im Schrank stehen, sondern die Ihre Kunden auch verwenden. Darüber hinaus entsprechen die Dokumente den gesetzlichen Vorgaben (Normen und Richtlinien) und tragen daher zur Produktsicherheit bei.
  • Online-Hilfen und Software-Handbücher, die den Anwendern wirklich helfen. Die Anwender werden befähigt und nicht bloß informiert.
  • Grafiken und technische Illustrationen, die Ihre Dokumente aufwerten und die Anwender optimal unterstützen.

Vorgehen bei unserer Beratung

Folgende Schritte führen uns gemeinsam zu optimalen Dokumenten:

  • Analyse Ihrer vorhandenen Texte und Dokumente (z. B. Betriebsanleitungen, Benutzerinformationen etc.) hinsichtlich der folgenden Kriterien:
    • Sind die Inhalte vollständig, ist aber auch keine überflüssiger Inhalte enthalten? Steht das drin, was die Anwender wissen müsse, aber auch nur das?
    • Sind die Inhalte verständlich? Befähigt die Dokumentation die Anwender, mit dem Produkt umzugehen?
    • Wie sind Struktur und Ordnung der Dokumente? Können die Anwender schnell finden, was sie suchen?
    • Sind die Dokumente konform zu den Normen und Richtlinien? Ist die bestehende Dokumentation rechtssicher?
  • 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

Folgende Schritte führen uns gemeinsam zu optimalen Grafiken:

  • Analyse der vorhandenen Grafiken
    • auf verwendete Darstellungsarten, auf effektive Grafikerstellung und Übersetzungsfähigkeit
    • auf Wirtschaftlichkeit bei der Erstellung
  • Gemeinsames Herausarbeiten Ihrer Anforderungen zur Grafikerstellung
  • Erstellung von Vorlagen für jede Illustrationsart
  • Erstellung von Bibliotheken mit wiederverwendbaren Teilillustrationen (Symbole, Piktogramme, Teile etc.)
  • Dokumentation eines Stilkonzepts für alle Illustrationen

Die Grundlage unserer Beratung

Die Qualität unserer Beratungsleistung basiert auf:

  • Langjähriger Erfahrung in der technischen Dokumentation, auch mit großen Projekten
  • Langjähriger Erfahrung beim Erstellen technischer Illustration in den verschiedensten Stilrichtungen
  • Detaillierter Kenntnis von Normen und Richtlinien für technische Dokumente und Zeichnungen
  • Der kognitiven Psychologie – Wahrnehmung und Gestaltpsychologie
  • Der Sprech-Akt-Theorie