Dienstleister für Software-Dokumentation
Sie haben eine innovative Software entwickelt? Wunderbar. Und wie steht es um Ihre Software-Dokumentation?
Unterstützen Sie Ihre Benutzer mit einer guten Software-Dokumentation? Erstellen Sie Ihre Software-Dokumentation auf effiziente Weise?
Vorteile guter Software-Dokumentation
Besseres Erlebnis Ihrer Kunden und Benutzer mit Ihrer Software
- Eine gute Software-Dokumentation unterstützt die Benutzer Ihrer Software dabei, das Konzept der Software zu verstehen und den Funktionsumfang sinnvoll zu nutzen.
- Benutzer, die zur Benutzung der Software eine Frage haben, nehmen es positiv zur Kenntnis, wenn zur Software auch eine hilfreiche Dokumentation mitgeliefert wird.
- Ihr Unternehmen kann die Software-Dokumentation als Teil des After-Sales-Marketings nutzen, der zu einem positiven Gesamteindruck von Ihrer Software beiträgt.
Entlastung Ihres Supports
- Im Problemfall schauen Benutzer in Ihre Software-Dokumentation – sofern vorhanden und gut auffindbar. Wenn sie dort schnell eine verständliche Antwort finden, erspart das Ihren Benutzern den Anruf bei Ihrem Supprt.
- Und gleichzeitig werden dadurch die Kapazitäten Ihres Supportteams weniger beansprucht. Ihre Supportmitarbeiter können sich auf die schwierigeren Problemfälle fokusieren.
Merkmale guter Software-Dokumentation
Zur Qualität einer Software-Dokumentation tragen viele Merkmale bei. Merkmale aus Sicht der Anwender sind zum Beispiel:
- zweckgerechter Inhalt und Umfang
- "So viel wie nötig, so wenig wie möglich."
- Genügt das Aufzählen von Handlungsschritten, oder soll der Benutzer das Bedienkonzept der Software verstehen?
- zielgruppengerechte und konsistente Sprache, Terminologie und Informationsstruktur
- Inkonsistenz erschwert das Verständnis seitens des Benutzers.
- Inkonsistente Sprache führt ggf. zu erhöhten Übersetzungskosten.
- konsistente Bildschirmfotos
- Bildschirmfoto-Konzept
- übersichtliche, funktionale und konsistente Gestaltung
- Die Gestaltung soll die Textfunktion und das Zurechtfinden in der Software-Dokumentation unterstützen.
- leichte Auffindbarkeit der Inhalte
- gutes Navigationskonzept
- gute Benutzerbarkeit der Software-Dokumentation
- auf unterschiedlichen Geräten und Bildschirmgrößen
- Barrierefreiheit
- korrekter Inhalt
- fachlich korrekt
- ggf. nahtlose Einbettung in die Software
- kontextsensitiver Aufruf von Hilfeinhalten
Software-Dokumentation effizient erstellen
Die Erstellung der Software-Dokumentation soll natürlich effizient und kostengünstig erfolgen. Dazu tragen folgende Aspekte bei:
- Standardisierungsmaßnahmen, die eine effiziente Erstellung konsistenter Software-Dokumentation erheblich erleichtern.
- Redaktionsleitfaden
- Terminologiemanagement
- Tipp: Ich biete passende Seminare an.
- ggf. Berücksichtigung relevanter Normen und Richtlinien
- effizienter Umgang mit Bildschirmfotos
- sinnvoller Umfang des Einsatzes
- effiziente und konsistente Erstellung von Bildschirmfotos mit geeigneter Software
- ggf. Vereinfachung und Reduzierung der Bildschirmfotos auf das Wesentliche
- ggf. sprachneutral oder Einbindung von Variablen
- modulare Erstellung und effiziente Mehrfachverwendung der Inhalte
- Modularisierungskonzept
- Verwendung eines geeigneten Redaktionssystems (CCMS)
- Ein CCMS kann Modularisierung, Versionierung, Variantenbildung, Workflows, Reviews uvm. erheblich vereinfachen.
- enge Zusammenarbeit mit Software-Entwicklern
- Bedienkonzepte und sprachliche Bezeichnungen entstehen oft schon bei der Programmierung der Software und sind später oft schwierig zu korrigieren.
Ihre Software-Dokumentation
Benötigen Sie für Ihre Software eine professionelle Software-Dokumentation? Oder benötigen Sie Beratung, um selbst effizient professionelle Software-Dokumentation erstellen zu können?
Ich freue mich auf Ihre Projektanfrage.