Projektdokumentation

Die Vorlage zur Projektdokumentation dient dazu, ein von Ihnen gewähltes oder vorgegebenes Softwareentwicklungsprojekt zu dokumentieren. Die Gliederung orientiert sich an den Phasen des objektorientierten Softwareentwicklungszyklus und enthält deshalb z.B. Abschnitte für die Projektvorstellung (Einleitung und Anforderungsüberblick), die Anforderungsanalyse, die Analyse, den Entwurf, den Test und das Deployment.

Die Vorlage wird in mehreren Lehrveranstaltungen in der Vertriefung Wirtschaftsinformatik im Studiengang BWL (dual) verwendet und hat je nach Schwerpunkt der Lehrveransatltung einen unterschiedlichen Umfang.

Umfang der Projektdokumentation

Die Aufgabenblätter, die innerhalb der jeweiligen Lehrveranstaltung zu bearbeiten sind, geben vor, welche Abschnitte Sie tatsächlich bearbeiten sollen. So kann es beispielsweise sein, dass Sie in der Lehrveranstaltung Ihre Anwendung nicht testen müssen. Trotzdem gibt es in der Vorlage den Abschnitt "Test". In diesem Fall kann der entsprechende Abschnitt in der Dokumentation Ihres Projektes leer bleiben oder gelöscht werden.

Die Aufgabenblätter geben auch vor, welchen Umfang die Projektdokumentation haben soll. Grundsätzlich gilt, dass zunächst die Anforderungen in voller Breite erhoben und anschließend priorisiert werden. Dann werden in den folgenden Abschnitten die hoch priorisierten Anforderungen weiter betrachtet. So wird der Umfang von Abschnitt zu Abschnitt schmaler, bis ein kleiner Ausschnitt tatsächlich zu entwerfen und zu programmieren ist. Achten Sie auf die Vorgaben zum Umfang in den Aufgabenblättern.

Es ist wichtig, dass Sie die ausgegebenen Aufgabenblätter genau beachten, damit Sie Ihr Projekt richtig dokumentieren!

Nach oben

Download der Vorlage für die Projektdokumentation

Hier können Sie die Vorlage für die Projektdokumentation in den Lehrveranstaltungen Datenbanksysteme 1 und 2 herunterladen. Diese Vorlagen unterscheiden sich, denn sie spiegeln die verschiedenen Lerninhalte der Lehrveranstaltugnen wider. Bitte laden Sie die Vorlage herunter, die zu Ihrer Lehrveranstaltung gehört. Sie können sie direkt mit MS Word bearbeiten. Sollten Sie MS Word nicht benutzen, orientieren Sie sich bitte an der bereitgestellten PDF-Version der Vorlage und erstellen Sie mit Ihrer Textverarbeitung ein eigenes Dokument.

Vorlage für Datenbanksysteme 1

DBS1: Komplett Herunterladen (*.zip)

Im Folgenden können Sie die Vorlage für die vollständige Projektdokumentation für die Lehrveranstaltung Datenbanksysteme 1 mit allen Abschnitten in verschiedenen Formaten herunterladen.

Vorlage für Datenbanksysteme 2

DBS2: Komplett Herunterladen (*.zip)

Im Folgenden können Sie die Vorlage für die vollständige Projektdokumentation für die Lehrveranstaltung Datenbanksysteme 2 mit allen Abschnitten in verschiedenen Formaten herunterladen.

Vorlage für Informatik-Anwendungen 1

IA1: Komplett Herunterladen (*.zip)

Im Folgenden können Sie die Vorlage für die vollständige Projektdokumentation für die Lehrveranstaltung Informatik-Anwendungen 1 mit allen Abschnitten in verschiedenen Formaten herunterladen.

Nach oben

Arbeit mit der Projektdokumentation

In der Vorlage werden verschiedene Word-Funktionen verwendet, die leider einigen Word-Benutzern nicht bekannt sind und deshalb zu Problemen führen. Beispielsweise wird mit Formatvorlagen, Verzeichnissen und Querverweisen gearbeitet. Schwierigkeiten bereitet die Arbeit mit Formatvorlagen häufig in Verbindung mit den Erläuterungen im ausgeblendeten Text. Deshalb: Blenden Sie die Hinweistexte ein, wenn Sie mit der Projektdokumentation arbeiten. Die Tastenkombination dafür ist STRG+SHIFT+* oder Sie klicken auf das Alle anzeigen-Icon im Menüband.

Abbildung zeigt, wie ausgeblendeter Text eingeblendet werden kann.

Nach oben

Beispiele dokumentierter Projekte

In diesem Abschnitt finden Sie Beispiele für einzelne Abschnitte der Projektdokumentation. Sie sollen Ihnen eine Orientierung bei der Dokumentation Ihres Softwareentwicklungsprojekts geben. Auch bei den Beispielen gilt, dass die Dokumentation so erfolgt ist, wie es das jeweilige Aufgabenblatt forderte. Es kann also sein, dass abhängig von Ihrer Aufgabenstellung die Inhalte anders aussehen müssen.

Beispiel "Urlaubsantragsverwaltung" für Datenbanksysteme 1 und 2

Das Projekt "Urlaubsantragsverwaltung" ist eine Windows Forms-Anwendung nach dem Model View Presenter-Muster mit dateibasiertem Zugriff auf eine MS Access-Datenbank. Es verwendet die Vorlage für Datenbanksystme 2 kann aber auch für Datenbanksysteme 1 zur Orientierung verwendet werden.

Komplett Herunterladen (*.zip)

 

Vollständige Projektdokumentation

Die Projektdokumentation steht als ein zusammenhängendes Dokument mit allen Abschnitten zur Verfügung. Sie können es wahlweise mit oder ohne Erläuterungstexte aus der Vorlage herunterladen.

Visual Studio-Projekt

Im Folgenden finden Sie das Visual Studio-Projekt inkl. der UML-Modellierung der Anforderungsanalyse und Analyse sowie die Entwurfsmodelle und den Quellcode eines Ausschnittes der Urlaubsantagsverwaltung.

Dokumentation von Studierendenprojekten

Im Folgenden finden Sie Beispiele von Studierenden aus den vergangenen Semestern, die freundlicherweise zur Veröffentlichung auf dieser Webseite zur Verfügung gestellt wurden.

Beispiele aus Datenbanksysteme 1

Beispiele aus Datenbanksysteme 2

  • - weitere folgen -

Nach oben

Konventionen für die Dokumentation und Entwicklung

Bei der Dokumentation Ihres Projekts sind zusätzlich zu den inhaltlichen Vorgaben auch formale Vorgaben zu erfüllen. In diesem Abschnitt werden sie als Konventionen für die Dokumentation und Modellierung bereitgestellt.

Komplett Herunterladen (*.zip)

Sie können die Konventionen für die Dokumentation der einzelnen Abschnitte im folgenden einzeln herunterladen.

Nach oben

Häufige Fragen und Antworten zur Projektdokumentation (FAQ)

Wenn ich zu einem späteren Zeitpunkt (z.B. im Entwurf) merke, dass bereits zu Beginn die Anforderung nicht richtig war, muss ich dann alles nochmal ändern?

Die Erkenntnis eine Anforderung zu Beginn nicht vollständig oder richtig spezifiziert zu haben, ist ein wichtiger Lerneffekt. Sie haben dann zwei Möglichkeiten: Sie konkretisieren oder verbessern die Beschreibung der Anforderung und aktualisieren dann die Dokumentation aller nachfolgenden Phasen (z.B. Analyse, Entwurf). Dadurch ist die Konsistenz innerhalb der Dokumentation sichergestellt. Das ist die beste Wahl, wenn Sie noch ausreichend Bearbeitungszeit haben oder Sie durch Vereinfachung der Anforderungen erheblichen Aufwand in späteren Phasen (z.B. in der Programmierung) sparen können. Als Alternative bleibt, dass Sie in der Phasen in der Sie die unvollständige oder fehlerhafte Anforderung identifiziert haben, darauf hinweisen. Das kann mit einer Fußnote im Text, mit Notizen im Diagramm usw. erfolgen. Sie sollten dann auch begründen, warum Sie auf eine Überarbeitung verzichtet haben. Wichtig ist der Lerneffekt! Versuchen Sie es beim nächsten Mal besser zu machen.

Wie kann ich UML-Diagramme aus einem Modellierungsprojekt im Visual Studio in Word einfügen?

Das geht ganz einfach über die Windows Zwischenablage, d.h. durch Kopieren und Einfügen: Öffnen Sie das UML-Diagramm im Visual Studio. Markieren Sie dann alle Modellelemente, die als Bild im Worddokument erscheinen sollen (z.B. mit der Tastenkombination Strg + A oder per Maus). Kopieren Sie Ihre Auswahl in die Zwischenablage (z.B. mit der Tastenkombination Strg + C oder per Menüeintrag in der Menüleiste bzw. im Kontextmenü). Wechseln Sie in Ihr Worddokument und positionieren Sie die Eingabemarkierung ("Cursor") an der Stelle, an der das Diagramm eingefügt werden soll. Fügen Sie es anschließend aus der Zwischenablage ein (z.B. mit der Tastenkombination Strg + V oder per Menüeintrag im Menüband bzw. im Kontextmenü.

Müssen wir die ganze Software dokumentieren?

Häufig wird gefragt, wie umfangreich die Dokumentation erfolgen soll (z.B. ob die ganze Software dokumentiert werden soll oder nur der Ausschnitt der am Ende tatsächlich realisiert wurde).

Stellen Sie sich die Abschnitte der Projektdokumentation wie einen Trichter vor. Ganz vorn im Dokument beschreiben Sie alle Anforderungen im Überblick. Damit zeigen Sie den vollständigen Umfang, den die Software haben könnte. Der Umfang ist dann in der Regel sehr breit.

Dann priorisieren Sie die Anforderungen und machen die Anforderungsanalyse der wichtigsten Anforderungen, d.h. nicht aller Anforderungen sondern nur der mit hoher Priorität. Dadurch wird der Umfang kleiner, wie beim Trichter.

Als Ergebnis der Anforderungsanalyse entstehen mehrere Anwendungsfälle. Von diesen Anwendungsfällen wählen Sie ca. drei wichtige Anwendungsfälle aus. Die ausgewählten Anwendungsfälle sollen einem Benutzer einen zusammenhängenden Ablauf in der Benutzung der Anwendung ermöglichen. (Triviale Anwendungsfälle, wie Login oder Logout, zählen hier nicht. Es müssen drei Anwendungsfälle mit wichtigen Funktionen sein.) Dadurch wird der Umfang wieder kleiner.

Die ausgewählten Anwendungsfälle verfeinern Sie in Analyse und Entwurf. In der Analyse ist einleitend auch die fachliche Gliederung mit Paketdiagrammen zu modellieren. Hier wäre es gut, wenn Sie alle Pakete identifizieren, die durch Analyse der ausgewählten Anwendungsfälle entstanden sind. Sie müssen in den folgenden Abschnitten der Analyse nicht alle Pakete beschreiben. Erläutern Sie im entsprechenden Abschnitt 4.1 Fachliche Gliederung, auf welche Pakete Sie sich beschränken und warum.

Es muss dann nach dem Entwurf erkennbar sein, wie die Lösung für die ausgewählten Anwendungsfälle aussehen wird. Von diesen Anwendungsfällen wählen Sie dann einen Ausschnitt. Der Ausschnitt sollte es dem Benutzer ermöglichen, auf mindestens einem Weg durch mindestens einen Anwendungsfall zu gelangen. Sie könnten z.B. auf Sonderfälle verzichten oder sich auf grundlegende Funktionen beschränken. Dadurch wird der Umfang wieder kleiner.

Diesen Ausschnitt programmieren Sie dann tatsächlich. Im Ergebnis sollte ein Benutzer also auf mindestens einem Weg durch mindestens einen Anwendungsfall gelangen können. Bei einer Datenbankanwendung ist das Ziel, dass die elementaren Funktionen zum Anlegen, Ändern, Anzeigen und Löschen umgesetzt werden (CRUD, d.h. Create, Read, Update und Delete).

Warum muss das sein?

Aus drei Gründen ist die Projektdokumentation wichtig. Grund Nr. 1 ist banal: Die Projektdokumentation ist Ihre Prüfungsleistung, für die Sie eine Bewertung (z.B. in Form einer Note) bekommen.

Aber warum ist es eine Prüfungsleistung? Damit kommen wir zu Grund Nr. 2: Softwareentwicklungsprojekte sind mit erheblichen Investitionen verbunden und produzieren ein Ergebnis dass deshalb typischerweise sehr lange genutzt wird. Ohne eine geeignete Dokumentation sind spätere Anpassungen oder Erweiterungen nur schwer zu planen und durchzuführen. Deshalb ist Dokumentation in Softwareentwicklungsprojekten sehr wichtig! Sie sollen Erfahrungen mit dieser Form technischer Dokumentation sammeln, bevor Sie in Projektorganisationen oder der Softwareentwicklung verantwortungsvolle Aufgaben (z.B. als Projektleiter) übernehmen.

Wenn Sie im Rahmen Ihrer Abschlussarbeit ein Softwareentwicklungsprojekt bearbeiten, werden Sie dort auch alle Phasen des Softwarelebenszyklus dokumentieren, um zu zeigen, was Sie im Studium gelernt haben. Sie sind dann bereits mit einer geeigneten Form der Dokumentation vertraut und können sich ganz auf die inhaltliche Arbeit konzentrieren. Grund Nr. 3 ist also die Vorbereitung auf eine erfolgreiche Abschlussarbeit.

Nach oben