Inhalt Struktur Gestaltung Dokumentationen Inhalt Struktur Gestaltung Veit-Wickert, WvS MA, 2001
Dokumentation als Tätigkeit als Ergebnis Beispiele Erstellung eines Benutzerhandbuchs Beschreibung des Projektverlaufs als Ergebnis Beispiele Benutzerhandbuch Abschlussbericht Protokolle Informationen für Benutzer Veit-Wickert, WvS MA, 2001
Kombination von Text und grafischen Elementen Formen Verbal – als Text Grafisch – z.B. Mindmap, Diagramme Kombination von Text und grafischen Elementen Veit-Wickert, WvS MA, 2001
Ziele Übersichtliche Darstellung komplexer Vorgänge Klärung von Aufgaben, Zuständigkeiten, Rechten, Pflichten, Problemen Einarbeitung von Außenstehenden Kontrolle von Vorgängen und Ergebnissen Hilfestellung bei Problemlösung, Fehlerkorrektur Veit-Wickert, WvS MA, 2001
Aktualität Vollständigkeit Übersichtlichkeit Verständlichkeit Anforderungen Aktualität Vollständigkeit Übersichtlichkeit Verständlichkeit Fehlerfreiheit Veit-Wickert, WvS MA, 2001
Inhaltsverzeichnis Projektdokumentation Projektantrag, Kundenanfrage, Lastenheft Voruntersuchung Projektauftrag Vereinbarungen Schriftverkehr Projektpläne Sitzungsprotokolle Status- Meilensteinprotokolle Abschluss-, Erfahrungsbericht Personal-, Telefon-, Mailinglisten Präsentationsunterlagen Veit-Wickert, WvS MA, 2001
Vorgehensweise Informationen sammeln Informationen bewerten und auswählen Informationen strukturieren Texte selbstständig formulieren Ein Literaturverzeichnis anfertigen Die äußere Form gestalten
Möglichkeiten der Strukturierung Einleitung: Z.B. Anlass der Dokumentation, Zielsetzung Hauptteil, z.B. Technische Voraussetzungen Lösungsweg, Vorgehensweise Oder Beschreibung einzelner Probleme und ihre Lösung Ergebnis, Bewertung, Ausblick Veit-Wickert, WvS MA, 2001
Gliederungsschritte Vom weniger Wichtigen zum Wichtigen oder Vom Einfachen zum Schwierigen Vom Besonderen zum Allgemeinen Veit-Wickert, WvS MA, 2001