Projektdokumentation Teil 2 Fachhochschule Dortmund Seminar IT-Consulting Sommersemester 2002 Peter Cramer 25.06.2002 c) Peter Cramer 2002

Projektdokumentation I Benutzerdokumentation - formale Gestaltung - inhaltliche Gestaltung II Systemdokumentation / Testdokumentation III Wartungsdokumentation 25.06.2002 c) Peter Cramer 2002

Benutzerdokumentation / Formale Kriterien Übersichtlichkeit - Aufbau und Gliederung - Orientierungshilfen - Format, Form und Gestaltung Vollständigkeit - Installationsbeschreibung - Beschreibung der Programm-Funktionalitäten - Fehlerbehandlung/ Ausnahmesituationen - Datensicherung, -reorganisaton - Unterstützung durch den Programmhersteller 25.06.2002 c) Peter Cramer 2002

Benutzerdokumentation / inhaltliche Kriterien Richtigkeit - Zuordnung zum Programm - Programmkonforme Darstellung - fachliche sachliche Richtigkeit - sprachliche Richtigkeit Verständlichkeit - Fachlicher Inhalt des Programms - Sprache und Sprachstil - Aufbereitung des fachlichen Inhaltes 25.06.2002 c) Peter Cramer 2002

Benutzerdokumentation / Inhaltliche Kriterien Eine Benutzerdokumentation muss sicher stellen, dass das Softwareprodukt ohne fremde Hilfe benutzt werden kann! Bestandteile einer Benutzerdokumentation allgemeine Systembeschreibung Installations- und Bedienungsanleitung Operator-Anleitung 25.06.2002 c) Peter Cramer 2002

Allgemeine Systembeschreibung Zweck des Softwaresystems, benötigte Hard- und Softwareressourcen die Art und Weise der Benutzer-System-Interaktion die Form der produzierten Ereignisse, organisatorische und informatorische Voraussetzungen implementierungsbedingte Restriktionen die Flexibilität und Portabilität des Softwaresystems. 25.06.2002 c) Peter Cramer 2002

Allgemeine Systembeschreibung Die allgemeine Systembeschreibung soll das System charakterisieren und dessen Stärken und Schwächen und vor allem auch dessen Grenzen aufzeigen ! Ihr Ziel besteht darin den Leser über den Zweck des Softwaresystems aufzuklären ! 25.06.2002 c) Peter Cramer 2002

Installations- und Bedienungsanleitung Input: Black Box Output: Bildschirm, Drucker etc. ... Daten + Benutzerinteraktionen Softwaresystem Das Softwaresystem wird als Black Box aufgefasst ! Nur Informationen über die Benutzerschnittstelle werden gemacht ! 25.06.2002 c) Peter Cramer 2002

Installationsanleitung Anleitung zur Installation / Upgrade-Anleitung Systemkonfiguration / Einbettung in die Umgebung Datei- und Datenbankformate Überprüfung der korrekten Installation Fehlersuche und -behebung 25.06.2002 c) Peter Cramer 2002

Bedienungsanleitung 1. Teil 2. Teil sequentiell lesbare Anleitung - zum Schnell- bzw. Ersteinstieg in die Bedienung des Softwaresystems 2. Teil Referenzhandbuch selektiv lesbar beschreibt die typischen Arbeiten und die dazu notwendigen Benutzeraktionen 25.06.2002 c) Peter Cramer 2002

Bedienungsanleitung Darstellung und Erläuterungen von Beispielergebnissen Zusammenstellung der Fehlermeldungen und Hinweise auf Fehlerursachen 25.06.2002 c) Peter Cramer 2002

Operator-Anleitung Nur für Software, die von einem Host überwacht wird ! Beschreibt die Nachrichten / Ereignisse die die Software auslöst und deren Bedeutung 25.06.2002 c) Peter Cramer 2002

Systemdokumentation Übersicht Systemspezifikation Implementierung im Großen Implementierung im Kleinen Beschreibung der verwendeten Dateien Testprotokollierung Listung aller Programme 25.06.2002 c) Peter Cramer 2002

Systemdokumentation - Systemspezifikation (meist schon im Vertrag mit dem Kunden vorhanden, muss nur in eine Aufgabenstellung umgearbeitet werden) - inkl. aller entwickelten Prototypen - bei wiederverwendbaren Prototypen - Dokumentieren der Änderungen - Sicherung und Dokumentation der Prototypen 25.06.2002 c) Peter Cramer 2002

Systemdokumentation Beschreibung der Implementierung im Großen - Zeigt die Konzeption und Grundstruktur der Software auf - Schnittstellendefinitionen - Teilsystemzerlegungen - gewählte Problemlösungen - Beschreibung von Grundlagen und Infrastruktur - Darstellung anhand von Diagrammen - Begründung für die gewählte Architektur - soll während des Entwurfsprozesses aufgestellt werden 25.06.2002 c) Peter Cramer 2002

Systemdokumentation - zu unterscheiden nach Art der Programmierung Beschreibung der Implementierung im Kleinen - zu unterscheiden nach Art der Programmierung Modulschnittstellen (Import, Export, Vererbung) Datenstrukturen, Datentypen Dateiformate, Satzaufbau, Organisationsform, Zugriffe Aufrufe von Prozeduren/ Methoden erforderliche Initialisierungen eventuell Erläuterungen kritischer Algorithmen Programmierrichtlinien 25.06.2002 c) Peter Cramer 2002

Systemdokumentation Dokumentation ist nicht gleich einer Kommentierung ! Formale Darstellungsmittel wie ER- und UML- Diagramme Data Dictionary Grammatiken Sind ausdrücklich erlaubt Präzision, Kürze und Eindeutigkeit haben Vorrang gegenüber der Lesbarkeit ! 25.06.2002 c) Peter Cramer 2002

Testdokumentation Die Testdokumentation dient zur Vereinfachung von Änderungen und Erweiterungen ! Sie ist die Grundlage für die Fehlersuche! 25.06.2002 c) Peter Cramer 2002

Testdokumentation Inhalt: Anforderungsdokumente Beschreibung der Dateien bzw. DB-Schnittstelle Testplan für jede Komponente Testspezifikation Testplan, -Daten für Integrationstest Testplan, -Daten für Akzeptanztest Programmlisting, Testprotokoll, etc. 25.06.2002 c) Peter Cramer 2002

Wartungsdokumentation Kriterien für die Wartbarkeit Verständlichkeit Komponentenunabhängigkeit Verwendete Programmiersprache Programmierstil 25.06.2002 c) Peter Cramer 2002

ENDE Kritik? Fragen? Verbesserungen? Anregungen?