Softwaredokumentation

Welche Arten von Softwaredokumentation gibt es, welche Dokumentation unterstützt den Softwareentwicklungsprozess und welche Tipps sind empfehlenswert?

Softwaredokumentation Definition

Die …

 

Der Zweck der Softwaredokumentation

Backlog Refinement - der Prozess zur Pflege von Backlog Items

Die Zielgruppen der Softwaredokumentation

Und an wen richtet sich die Softwaredokumentation? An jeden, der mit einer Software in Berührung kommt und ein Informationsbedürfnis hat. Also z. B. 

  • Entwickler, die bspw. neue Programme realisieren, Erweiterungen implementieren, Tools über Schnittstellen anbinden oder Refactorings durchführen wollen,
  • Anwender, die Hilfe bei der Anwendung von Funktionen oder Informationen über neue Features suchen,
  • Einkäufer und andere verantwortliche Mitarbeiter, die bewerten müssen, ob eine Software ihren Anforderungen genügt, so dass sie ggf. beschafft werden kann.
  • Tester, die wissen müssen, was eine Software tun soll, um zu überprüfen, ob die Akzeptanzkriterien erfüllt werden.
  • Roll-out Manager und andere verantwortliche Mitarbeiter, die beurteilen müssen, ob sich das Roll-out einer neuen Version für eine Organisation lohnt.
  • Einkäufer und andere verantwortliche Mitarbeiter, die bewerten müssen, ob eine Software ihren Anforderungen genügt, so dass sie ggf. beschafft werden kann.
  • Compliance-Verantwortliche, die sicher stellen müssen, dass geltende Regeln, Normen und Gesetze eingehalten werden.
  • Datenschutzbeauftragte oder Betriebsräte, die überprüfen müssen, ob die Datenschutzregeln für die Mitarbeiter eingehalten werden.

 

 

Backlog Refinement in der Praxis

Arten der Softwaredokumentation

 

abc

Dokumentation im Softwareentwicklungsprozess

Die Dokumentation im Code

Traceability bis in den Code

 

Herausforderungen für Unternehmen

Tipps für die Erstellung einer Softwaredokumentation

Informationen zu dokumentieren, um sie zu dokumentieren, ist nicht zu empfehlen. 

Impuls zum Diskutieren:

Hinweise:

Hier finden Sie ergänzende Informationen aus dem t2informatik Blog:

t2informatik Blog: Softwareauswahl in 10 Schritten

Softwareauswahl in 10 Schritten

t2informatik Blog: Faktoren der Softwareakzeptanz

Faktoren der Softwareakzeptanz

t2informatik Blog: Software kaufen oder entwickeln lassen

Software kaufen oder entwickeln lassen