25.06.2002 c) Peter Cramer 2002 1

Projektdokumentation Teil 2

Fachhochschule Dortmund

Seminar IT-Consulting

Sommersemester 2002

Peter Cramer

25.06.2002 c) Peter Cramer 2002 2

Projektdokumentation

I Benutzerdokumentation

- formale Gestaltung

- inhaltliche Gestaltung

II Systemdokumentation / Testdokumentation

III Wartungsdokumentation

25.06.2002 c) Peter Cramer 2002 3

Benutzerdokumentation / Formale Kriterien

• Vollständigkeit

- Installationsbeschreibung

- Beschreibung der Programm-Funktionalitäten

- Fehlerbehandlung/ Ausnahmesituationen

- Datensicherung, -reorganisaton

- Unterstützung durch den Programmhersteller

• Übersichtlichkeit

- Aufbau und Gliederung

- Orientierungshilfen

- Format, Form und Gestaltung

25.06.2002 c) Peter Cramer 2002 4

Benutzerdokumentation / inhaltliche Kriterien

• Verständlichkeit

- Fachlicher Inhalt des Programms

- Sprache und Sprachstil

- Aufbereitung des fachlichen Inhaltes

• Richtigkeit- Zuordnung zum Programm

- Programmkonforme Darstellung

- fachliche sachliche Richtigkeit

- sprachliche Richtigkeit

25.06.2002 c) Peter Cramer 2002 5

Benutzerdokumentation / Inhaltliche Kriterien

Bestandteile einer Benutzerdokumentation

• allgemeine Systembeschreibung

• Installations- und Bedienungsanleitung

• Operator-Anleitung

Eine Benutzerdokumentation muss sicher stellen, dass das Softwareprodukt ohne fremde Hilfe benutzt werden kann!

25.06.2002 c) Peter Cramer 2002 6

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 7

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 8

Installations- und Bedienungsanleitung

• Das Softwaresystem wird als Black Box aufgefasst !

• Nur Informationen über die Benutzerschnittstelle werden gemacht !

Input:

Daten + Benutzerinteraktionen

Output:

Bildschirm, Drucker etc. ...

Black Box

Softwaresystem

25.06.2002 c) Peter Cramer 2002 9

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 10

Bedienungsanleitung

• 1. Teilsequentiell lesbare Anleitung

- zum Schnell- bzw. Ersteinstieg in die Bedienung des Softwaresystems

• 2. TeilReferenzhandbuch

– selektiv lesbar– beschreibt die

typischen Arbeiten und die dazu notwendigenBenutzeraktionen

25.06.2002 c) Peter Cramer 2002 11

Bedienungsanleitung

• Darstellung und Erläuterungen von Beispielergebnissen

• Zusammenstellung der Fehlermeldungen und Hinweise auf Fehlerursachen

25.06.2002 c) Peter Cramer 2002 12

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 13

Systemdokumentation

• Systemspezifikation• Implementierung im Großen• Implementierung im Kleinen• Beschreibung der verwendeten Dateien• Testprotokollierung• Listung aller Programme

Übersicht

25.06.2002 c) Peter Cramer 2002 14

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 15

Systemdokumentation

- 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

Beschreibung der Implementierung im Großen

25.06.2002 c) Peter Cramer 2002 16

Systemdokumentation

- 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

Beschreibung der Implementierung im Kleinen

25.06.2002 c) Peter Cramer 2002 17

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 18

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 19

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 20

Wartungsdokumentation

• Verständlichkeit• Komponentenunabhängigkeit• Verwendete Programmiersprache• Programmierstil

Kriterien für die Wartbarkeit

Fragen?Kritik?

Anregungen?Verbesserungen?

ENDE