Überspringen zu Hauptinhalt

Software Dokumentation – Wie ist eine Software Dokumentation aufgebaut?

In der Praxis hat sich ein gewisses Schema für den Aufbau einer Software Dokumentation etabliert. Zuerst beschreibt man die Grundlagen der Software. Die Anleitung beschreibt hierbei zuerst was für eine Funktion die Software hat und wie das Programm funktioniert.

Danach geht man auf Datenstrukturen ein und was zu berücksichtigen ist, wie biespielsweise was alles beim Quellcode relevant ist. Oder welche Test die Software durchlaufen haben muss, um Ihre Funktionalität zu prüfen. Im Anschluss geht man darauf ein, welche Hardware und Software erfoderlich ist, um das Programm zu nutzen. Da eine Software häufig weiterentwickelt wird, sollten auch die Unterschiede der jeweiligen Versionen festgehalten werden. Hierfür sollte am Ende der Software Dokumentation noch Platz sein, um Ergänzungen einzutragen.

An den Anfang scrollen