Softwaredokumentation

Die Anforderungen und Aufgaben von Softwaredokumentation sind vielfältig.

Unterschieden werden muss zwischen Standardsoftware oder kundenspezifischer Anpassung / Entwicklung, zwischen Lebensphasen des Softwareproduktes (Entwicklungsphase, verschiedene Testphasen, Etablierung am Markt, Realeasewechsel-, Update- und Upgrade-Phase, Migration und Abkündigung).

Aus Kundensicht gibt es verschiedene Rollen, die mit unterschiedlichen Informationen versorgt werden müssen: Einkauf-/Marketinginformationen, Administrations- und Installationsunterlagen, Schulungsinformationen, Anwenderhandbuch, Systemhandbuch, Migrations- und Update-Guide.

Softwaredokumentation ist aber auch hilfreich beim KnowHow-Transfer: eLearning und VideoTutorials erleichtern erheblich den Zugang zum Wissen rund um Software.

Da wir selbst Software entwickeln und Softwareprojekte für viele Kunden durchführen, haben wir die Erfahrung und das Wissen, welche Informationen wo benötigt werden und wie diese aufbereitet sein müssen. Kontextsenistive Online-Hilfe, konsistente Terminologie in Produktinformationen, Quelltextbeschreibungen und Bedieneroberflächen sind dazu ebenso wichtig, wie die aktuelle Verfügbarkeit in allen benötigten Sprachen.


Softwaredokumentationen (Beispiele):

  • Anwenderdokumentation
  • Installationsanleitung
  • Online-Hilfe
  • Administrationshandbuch
  • Fehlersuche / Troubleshooting
  • Leistungsbeschreibung
  • Prospekt
  • Kurzanleitung
  • Quickstart-Guide
  • Marketingunterlagen
  • Schulungsunterlagen
  • Update-Dokumentation
  • Release-Notes
  • Lastenhefte
  • Pflichtenhefte
  • Quellcode-Dokumentation

Medien und Strukturen:

  • Papier und PDF
  • Kontextsensitive Online-Hilfe
  • Diverse Hilfe-Formate und WebHelp
  • Video-Tutorial
  • eLearning
  • ePub
  • XML-Standards, wie DITA und DocBook

Aufgabengebiete:

  • Terminologiemanagement
  • Mehrsprachigkeit und Übersetzungsmanagement
  • Re-Use und Modularisierung
  • Produkt- und Projektdokumentation
  • Interne und externe Dokumentation