Software-Dokumentation

Die Software-Dokumentation ist eine spezialisierte Form der technischen Dokumentation. Erläutert werden hierbei die Anwendungsprogramme, die der Nutzer auf einem PC ausführt, d.h. die Bedienung der Oberfläche, das Erreichen bestimmter Ziele, die Unterschützung des Anwenders im Problemfall. Insbesondere branchenspezifische Softwarelösungen oder Anwendungen mit einem sehr technischen Background machen es notwendig, dem Anwender bei der Dokumentation stets "in seiner Sprache" zu begegnen, d.h. nicht nur in einer für ihn verständlichen Form, sondern auch mit den spezifischen Fachvokabular.

In der Regel wird die Software-Dokumentation mindestens in Form eines klassischen Handbuches und als Online-Dokumentationen (Hilfefunktion im Programm) angeboten. Letzteres macht es erforderlich, einzelne Textabschnitte direkt mit dem Anwendungsfall des Users zu verknüpfen, so dass der Hilfesuchende direkt in das für ihn relevante Kapitel geleitet wird. Bei der Umsetzung derartiger Verknüpfungen zwischen Dokumentation und Anwendungsprogramm helfen spezielle Dienstprogramme.

Eine weitere Form der Software-Dokumentation ist die Code-Dokumentation (oder System-Dokumentation), also die technische Beschreibung des entwickelten Quellcodes.

 

Download Schulungsfolien "Software verständlich dokumentieren"

Download!

Foliensatz zu einer Schulung zum Thema "Software-Dokumentation".
26 Seiten, September 2009 (PDF, 185 KB).