Die Präsentation wird geladen. Bitte warten

Die Präsentation wird geladen. Bitte warten

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

Ähnliche Präsentationen


Präsentation zum Thema: "25.06.2002c) Peter Cramer 20021 Projektdokumentation Teil 2 Fachhochschule Dortmund Seminar IT-Consulting Sommersemester 2002 Peter Cramer."—  Präsentation transkript:

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

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

3 c) Peter Cramer 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

4 c) Peter Cramer 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

5 c) Peter Cramer 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!

6 c) Peter Cramer 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.

7 c) Peter Cramer 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 !

8 c) Peter Cramer 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

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

10 c) Peter Cramer Bedienungsanleitung 1. 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

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

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

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

14 c) Peter Cramer 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

15 c) Peter Cramer 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

16 c) Peter Cramer 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

17 c) Peter Cramer 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 !

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

19 c) Peter Cramer 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.

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

21 Fragen? Kritik? Anregungen? Verbesserungen? ENDE


Herunterladen ppt "25.06.2002c) Peter Cramer 20021 Projektdokumentation Teil 2 Fachhochschule Dortmund Seminar IT-Consulting Sommersemester 2002 Peter Cramer."

Ähnliche Präsentationen


Google-Anzeigen