Als Dienstleister für technische Dokumentation unterstützen wir Sie bei allen Aufgaben in diesem Bereich. Wir können auf drei Ebenen für Sie aktiv werden:

  • Beraten (Prozesse, IT-Systeme, Best practices usw.)
  • Evaluieren (Prüfung von bestehenden Dokumenten und Prozesse)
  • Schreiben (Erstellung von neuen Dokumenten maßgeschneidert auf Ihre Produkte)

Beraten

Sie möchten eine technische Redaktion aufbauen und benötigen einen Überblick über rechtliche Rahmenbedingungen, Technologien und Best Practices. Gerne nehmen wir gemeinsam mit Ihnen eine Bestandsaufnahme vor. Auf dieser Basis bereiten wir Empfehlungen vor, welche Werkzeuge und Prozesse in Ihrer technischen Redaktion eingesetzt werden sollten.

Auf Wunsch fassen wir unsere Empfehlungen in einem Redaktionsleitfaden für die ISO 9001-Zertifizierung zusammen.

Mit einem Modularisierungskonzept stellen wir sicher, dass Inhalte nur einmalig erstellt zu werden brauchen.

Evaluieren

Sie möchten Ihren bestehenden Dokumente überarbeiten? Gerne geben wir Ihnen eine ausführliches Feedback zu Ihren bestehenden Dokumenten. Wir prüfen Dokumente in Bezug auf Grammatik und Stil. Darüber hinaus gehen wir auch ergonomische und auf lernpsychologische Aspekte eingehen.

Auf der Basis von Utility-Tests können wir Ihnen zeigen, wie Sie hochwirksame Dokumente erstellen, die optimal von Anwendern verstanden und genutzt werden.

Darüber hinaus geben wir Ihnen auch gerne detaillierte Feedbacks zu den rechtlichen und normativen Vorgaben, die in technischen Dokumenten beachtet werden müssen.

Schreiben

Wir sind mit zahlreichen Dokumentarten vertraut, die im Bereich der Technischen Redaktion vorkommen. Eine zusammenfassende Bezeichnung für diese Dokumenten ist “Benutzerinformation”.

Benutzerinformationen können in folgenden Formen vorliegen:

  • Bedienungsanleitungen
  • Software-Hilfe
  • Assistenten
  • Aufkleber
  • Beschreibungstexte aller Art
  • Service-Manuals
  • Utility-Videos
  • usw.

Sie merken schon – Die Liste lässt sich fast unbegrenzt fortsetzen. Bei all diesen Bereichen können wir Sie tatkräftig und mit Know-How unterstützen.

Compliance

Die Verpflichtung, einer Maschine oder einem Gerät eine Bedienungsanleitung mitzuliefern, ergibt sich aus verschiedenen Rechtsbereichen. Wichtig sind hier EU-Richtlinien, die in geltendes Recht übergegangen sind (Produktsicherheitsgesetz) und das Vertragsrecht.

Darüber hinaus gibt es weitere Rechtsbereiche, wie z.B. das BGB (das Montageanleitungen ganz kurz erwähnt), das Produkthaftungsrecht.

Die Maschinenrichtlinie schreibt als Bestandteil des Produktsicherheitsgesetztes eine Bedienungsanleitung unmittelbar vor und legt auch gleich fest, was eine Bedienungsanleitung enthalten muss.

Bedienungsanleitungen selbst schreiben?

In kleineren Unternehmen werden Dokumentationen meist nebenbei von Entwicklern selbst geschrieben. Bei Startup-Firmen ist die Erstellung von Bedienungsanleitungen in Eigenarbeit oft unvermeidlich. Für diese Gruppe haben wir hier ein kleines Einführungstutorial vorbereitet.

Aber auch der Einsatz einer professionellen technischen Redaktion wird erforderlich, wenn die Dokumentation einen gewissen Umfang erreicht. Insbesondere die zahlreichen Fragen zu den rechtlichen Anforderungen sind für Entwicklungsabteilungen kaum noch zu bewältigen. Man kann dies ein wenig mit der Buchhaltung im Rechnungswesen vergleichen. Da wird der Steuerberater irgendwann unabdingbar.

Ein guter technischer Redakteur hilft dabei, dass sich Entwicklungsabteilungen und Unternehmen auf Ihre Kernkompetenz konzentrieren können.