Überspringen zu Hauptinhalt

Software Dokumentation – Wie unterscheidet sich eine Software Dokumentation von einer Technischen Dokumentation?

Das Schreiben einer Software Dokumentation unterscheidet sich von einer normalen Technischen Dokumentation. Wie die Anleitung für Software aufgebaut ist, hängt davon ab wie häufig man die Software verwendet.

Bei einmaliger Nutzung möchte der Anwender schnell und ohne seitenlanges Lesen handeln. Hier genügt eine Kurzanleitung oder Checkliste, welche die richtige Bedienung sicherstellt. Eine komplexe Software, die regelmäßig zum Einsatz kommt, hingegen, bedarf unterstützende Erläuterungen, die der Anwender in sich aufnehmen kann. Der Nutzer will nicht bei jeder Anwendung die Software Dokumentation zur Rate ziehen. Hier muss die Anleitung eine systematische Einarbeitung in die Grundlagen der Software bieten und Zusammenhänge verständlich erklären.

An den Anfang scrollen