Ist ein Konzept für Software-Dokumentation sinnvoll?

Bevor Sie mit der Erstellung der Benutzerdokumentation für eine neue Software beginnen, stellt sich die Frage, ob sich ein umfassendes Konzept für die Erstellung rentiert.

Diese Frage lässt sich nicht pauschal beantworten, es kommt auf das Software-Produkt an.

Für ein fast "selbsterklärendes" Software-Produkt (z. B. eine einfache App) ist ein Konzept nicht unbedingt notwendig. Die Ressourcen könnten Sie hier evtl. besser bei der Optimierung der Benutzerfreundlichkeit investieren.

Für eine komplexe Systemsoftware ist es unabdingbar, ein Konzept zu erstellen. Idealerweise wird dieses bei der Entwicklungsarbeit für das Software-Projekt von Anfang an berücksichtigt. So lassen sich Synergieeffekte leichter erkennen und nutzen.

Pro

  • Basis für eine maßgeschneiderte Benutzerdokumentation für Ihr Software-Produkt
  • Minimierung der Supportanfragen, durch eine zielgruppengerechte Benutzerdokumentation
  • Idealerweise eine enge Verknüpfung mit der "internen" Dokumentation
  • Bereits vorhandene Ressourcen und Informationen werden aufgezeigt und können in den Erstellungs-Prozess passgenau integriert werden
  • Änderungen können in der Konzeptphase noch leicht und einfach vorgenommen werden; treten Änderungswünsche erst bei der Erstellung auf, müssen diese teilweise aufwändig und an vielen Stellen eingefügt werden - schon ist die Kostenersparnis ohne Konzept dahin.

Kontra

  • Zeit- und kostenintensiv

Ein umfassendes Konzept kostet Ressourcen und Zeit. Gerade im Tagesgeschäft gerät die Konzepterstellung für die Benutzerdokumentation gern ins Hintertreffen.

Natürlich möchten Sie Ihre Ressourcen dort einsetzen, wo diese am effektivsten sind und produktiv zum Unternehmenserfolg beitragen.

Deshalb ist bei der Erstellung eines umfassenden Konzepts oft ein externer Dienstleister oder die eigene Dokumentationsabteilung am besten geeignet.

Gern unterstützen wir Sie bei der Erstellung eines Dokumentationskonzepts!

Dokumentationskonzept

Ein solides Dokumentationskonzept muss nicht unbedingt umfangreich sein, es sollte jedoch mindestens folgende Punkte beleuchten:

Produktbeurteilung

Nehmen Sie im ersten Schritt eine Einordung Ihrer Software vor. Die nachfolgende Tabelle gibt Ihnen dafür gute Anhaltspunkte.

 

Zielgruppe

Definieren Sie die Zielgruppen und deren Anforderungen.

Rahmenbedingungen

Klären Sie die Termine, das Budget und vorhandene / benötigte Ressourcen.

Integration in vorhandene Systeme / Abläufe

Wie soll das Anwenderhandbuch in die vorhandene Informationsstruktur intern eingefügtwerden?
Gibt es Schnittmengen zwischen Softwareentwicklung und Benutzerdokumentation?

Dokumente / Versionierung

Welche Dokumente sollen erstellt werden?
Alle Informationen in einem Dokument oder verschiedene Handbücher für unterschiedliche Anwendungszwecke und Benutzergruppen?

Wie wahrscheinlich sind zukünftige Überarbeitungen? Wie wird die Nachverfolgbarkeit von Änderungen sichergestellt?

Medien

Gedrucktes Handbuch, PDF, kontextsensitive Online-Hilfe oder am besten alles zusammen aus einer Quelle?
Welche Informationen sollen ins Handbuch, welche in die Online-Dokumentation?

Toolauswahl

Welches Dokumentationstool soll verwendet werden?
Anforderungen an das Tool definieren (Variantensteuerung, Mehrsprachigkeit, Ausgabemedien, Anbindung an vorhandene Systeme, etc.).

Struktur, Gliederung, Navigation

Struktur und Gliederung der Dokumente (Kapitel, welche Topics), Navigationselemente im Dokument, Hilfe-Formate, kontextsensitive Hilfe-Aufrufe.

Informationstypen

Welche Informationen werden dargestellt?
Allgemeine Grundlageninformationen, detaillierte Referenzinformationen, schrittweise Handlungsanweisungen, allgemeines Wissen über das Umfeld der Anwendung oder Beschreibung der Produktbedienung.
Wie erfolgt die Darstellung?

Funktionen der Software

Grundlegende Funktionen, spezielle Anwendungsfälle der Kunden?

Bei umfangreicher Software können Sie mit Hilfe des Konzepts eine enorme Zeit- und Kostenersparnis erzielen. Aber auch bei kleineren Projekten sollten Sie zumindest die grundlegenden Fragen klären, bevor Sie mit der Erstellung beginnen.

Jetzt kostenloses Angebot anfordern!

Weitere Artikel, die Sie interessieren könnten