Technische Dokumentation für professionelle Software

Software wird immer komplexer, ihr Aufbau ist oft modular, ihre Funktionen lassen sich individuell konfigurieren, noch dazu lässt sich die Bedienoberfläche an die jeweiligen Bedürfnisse anpassen. Anders als Hardware, die unveränderbar ist, ist Software maximal flexibel. Diese Komplexität und Flexibilität macht die Beschreibung einer Software nicht gerade einfach. Es ist kaum möglich, die Struktur einer Software in einem klassisch strukturierten Benutzerhandbuch abzubilden. Versucht man es dennoch, verliert man sich in vielen Kapitelebenen, mit der Folge, dass die Informationen nur schwer gefunden werden können. Andere Lösungen sind gefragt.

Nutzerinnen und Nutzer wollen wissen, was die Software kann, sie möchten das große Ganze verstehen und die Besonderheiten erfahren. Nicht alle Funktionen und Optionen sind auf den ersten Blick ersichtlich, manches versteckt sich in anderen Ebenen, in Kontextmenüs oder Dialogfenstern. Auch Abhängigkeiten sind nicht offensichtlich, etwa wenn sich die Einstellung für einen Parameter auf andere Parameter auswirkt. All das muss beschrieben werden, und zwar so, dass es schnell gefunden werden kann.

Was wir konkret machen

  • Egal ob großes Softwarepaket oder kleine App, unsere Technische Redakteure müssen abwägen, was die Dokumentation leisten muss, ob ein klassisches Handbuch oder eine kontextsensitive Onlinehilfe mehr Nutzen verspricht. Manchmal ist auch ein Medienmix sinnvoll: Schulungsunterlagen für die ersten Schritte auf Papier und detaillierte Hilfetexte für Fortgeschrittene online.
  • Wir wählen die geeignetste Methode für die Beschreibung aus: Schritt-für-Schritt-Anleitung versus Funktionsbeschreibung, Multimediales Funktionsdesign (MMFD) versus Every Page is Page One (EPPO), sequenzielle Beschreibung versus Hypertext.
  • Wir erstellen die Hilfetexte zielgruppengerecht, reichern diese bei Bedarf mit Grafiken, Animationen oder Videos an.
  • Sobald die Software in einer neuen Version vorliegt, aktualisieren wir die Dokumentation, damit nach jedem Update auch die Dokumentation up to date ist.

Das ZINDEL-Plus

Bei ZINDEL wissen wir, wie man Softwaredokumentation verständlich schreibt und illustriert. Ob sie besser als Schulungsunterlage verteilt wird oder als Onlinehilfe eingebunden wird. Unsere Technische Redaktion ist genau darauf spezialisiert. Unsere Projektteams setzen sich z.B. zusammen aus Technischen Redakteuren, Spezialistinnen für Technische Illustration, Experten für die Gestaltung und das Publishing sowie Übersetzungsmanagerinnen.

Für die Erstellung der Softwaredokumentation setzen wir moderne Redaktionssysteme ein, damit schon die nächste Anleitung günstiger wird. Für die Übersetzungen nutzen wir ein Translation-Memory-System, um die Übersetzungskosten mittelfristig zu senken.

Darauf können Sie sich verlassen:

  • Know-how von 30 Spezialisten sowie über 25 Jahre Erfahrung und Innovation
  • Umsetzung relevanter Richtlinien und Normen wie IEC/IEEE 82079-1 und ANSI Z535
  • Zertifiziert nach ISO 9001, registriert für ISO 17100, prämiert mit 8 tekom-Dokupreisen

Sie brauchen die Softwaredokumentation nicht neu zu erfinden. Nutzen Sie unsere Erfahrung!

Sie benötigen Unterstützung im Bereich Software?

Unser Kundenberater Stefan Zindel steht Ihnen gerne persönlich zur Verfügung. Schreiben Sie uns über unser Kontaktformular und fordern einen Beratungstermin oder Ihr individuelles Angebot an!

Jetzt anfragen

Jetzt anfragen