Inhaltsverzeichnis

Startseite

Einleitung

Dokumentation für den Endanwender

System-Dokumentation

Projektdokumentation mit SoDoM

Zusammenfassung

Literaturverzeichnis

Online-Folien

Einleitung:

Die Dokumentation von Software wird immer wichtiger. In den Anfängen der Computerindustrie, in den 50er und 60er Jahren waren die Programme noch überschaubar, da die Rechenleistung derzeitiger Computersysteme noch sehr eingeschränkt war. Heutige Softwaresysteme, insbesondere Frameworks, sind jedoch aufgrund der stark angestiegenen Rechenleistung heutiger Maschinen derart umfangreich und komplex geworden, daß diese Software ohne eine qualitativ hochwertige Dokumentation nicht mehr zu warten ist.

Eine gute und vollständige Dokumentation erlaubt jedoch nicht nur die Wartung von Softwaresystemen, sondern ermöglicht es zudem auch Entwurfsentscheidungen, die in den frühen Phasen des Entwicklungsprozesses getroffen werden, für andere nachvollziehbar zu gestalten. Voraussetzung hierfür ist allerdings eine qualitativ hochwertige Dokumentation dieser Entwurfsentscheidungen. Viele Entwickler neigen dazu, Softwarekomponenten von Anfang an neu zu entwickeln, da sie aufgrund der meist sehr schlechten Dokumentation nicht erkennen können, ob die wiederzuverwendene Komponente ihren Ansprüchen genügt. Wird hingegen der Entwicklungsprozeß von Softwarekomponenten ausreichend und vollständig dokumentiert, so wirkt sich dies positiv auf die Motivation des Entwicklers aus, diese Komponente wiederzuverwenden. Er kann dann sicher sein, daß sie das leistet, was sie leisten soll. Eine gute Dokumentation fördert somit die Wiederverwendbarkeit von Softwaresystemen und trägt zur Qualitätssicherung mit bei.

Die folgende Arbeit befasst sich mit den 3 wichtigsten Dokumentationsarten von Softwaresystemen:

• Kapitel 1 - Dokumentation für den Endanwender

• Kapitel 2 - System-Dokumentation

• Kapitel 3 - Projekt-Dokumentation mit SoDoM

Heutzutage trifft man in der Industrie meist auf nur wenig oder nur schlecht dokumentierte Softwaresysteme. Daraus ergeben sich zahlreiche Probleme bei der Wartung und der Wiederverwendung von Softwarekomponenten. Gute Software-Dokumentation kann helfen, 3 der wichtigsten in der Softwareindustrie auftretenden Probleme anzugehen:

1. Wie können neue Mitarbeiter effektiver in ein bestehendes Entwicklungsteam integriert werden? Wie kann man die Einarbeitungszeit verkürzen?

2. Wie lassen sich Softwaresysteme durch gute Dokumentation wartbar und wiederverwendbar gestalten?

3. Wie kann das Entwurfs- und Erfahrungswissen eines Unternehmens (angesichts häufiger Abwanderung von Entwicklern (braindrain-Effekt)) erhalten und gesichert werden?

Auf diese Problemstellungen geben die folgenden 3 Kapitel Lösungsansätze.