Die Softwaredokumentation unterscheidet sich grob zwischen Benutzerdokumentation und interner Entwicklerdokumentation. Vor allem die interne Entwicklerdokumentation ist ein wichtiger Teil der Qualitätssicherung innerhalb der professionellen Webentwicklung einer Digitalagentur.
Eine unvollständige Softwaredokumentation für ein großes Softwareprojekt führt häufig zu Kommunikationsproblemen und Schwierigkeiten bei der Softwareweiterentwicklung. Häufig wird für die Dokumentation eine entsprechende Dokumentationssoftware genutzt, die rechtlichen Anforderungen genügt. Sie wird von technischen Redakteuren, Entwicklern oder Fachanwendern verfasst.
Eine gute und sinnvolle Softwaredokumentation enthält bspw. Produktanforderungen und Softwaredesign-Dokumente (Backlogs, Use Cases, User-Storys, Pflichtenheft) sowie technische Spezifikationen oder auch Produktdokumente. Sie definiert darüber hinaus Schnittstellen.
- Frameworks
- SDK
- Technische Standards
- APIs
Diese Form der Dokumentation soll im besten Fall Informationen bereithalten, die Softwareentwickler benötigen, um zukünftige Programmieraufgaben zu lösen, Erweiterungen zu erstellen, Bugs zu beheben etc. So beugen sie einem möglichen Wissensverlust durch einen Personal- oder Unternehmenswechsel vor.
Die Softwaredokumentation für die Benutzer ist hingegen ein Anwenderdokument. Sie erklärt und beschreibt weitgehend detailgenau, wie das jeweilige Softwareprodukt funktioniert und wie der Endnutzer damit umgehen sollte.