Home   >  Übersicht SoSe 2004   >   Projekt: Lookedup4you   >   Ressourcen   >   Input Dokumentation

Dokumentation

Dokumentation

Dokumentation

Dokumentation von Produkten (Software, Websites etc.) dient Auftraggebern als Leistungsnachweis (Gewährleistung), Nutzern als Bedienungsanleitung und Produktentwicklern sowie Anwendern zum Informationsaustausch sowie zur Pflege und Weiterentwicklung des Produktes. Entsprechend unterscheidet man zwischen externer Produktdokmentation für Auftraggeber und Nutzer und interner Produktdokumentation für Entwickler und Anwender.

 

Zweck Dokumentation

1.Wissensspeicherung
Die Dokumentation hält die wesentlichen Designkriterien, Entwurfspläne und Begründungen (Hinweise auf Literatur und Ressourcen) fest.

2. Kommunikation
Die Dokumentation informiert die Teammitarbeiter über den Stand des Projektes, die Entwurfsentscheidungen und die noch anstehenden Aufgaben.

3. Kooperation und Arbeitsabläufe
Die interne Dokumentation ist Grundlage für die Arbeit der anderen Projektteams und dient damit der Kooperation und Organisation der Arbeitsabläufe. Eine schriftliche Festlegung von Entwurfsentscheidungen und Begründungen der Entscheidungen sowie alternativer Vorschläge kann darüber hinaus hilfreich sein, wenn es Schwierigkeiten bei der Realisierung des bevorzugten Vorschlags gibt.

4. Wartbarkeit
Zur Weiterentwicklung und Pflege des Produktes (z. B. durch den Auftraggeber) ist eine detaillierte Dokumentation Voraussetzung. Z.B. Ergänzungen von Text, Einrichten neuer Seiten, Ausbau der Navigation müssen den erarbeiteten Richtlinien entsprechen.

 

Inhalt der Dokumentation

  • Ziele der Anwendung (Programm, Website), Zielgruppe
  • Anforderungsspezifikation
  • Verwendete Hilfsmittel (Materialien, Programme etc.)
  • Schema für Benennungskonventionen (Dateinamen etc.)
  • Entwürfe (evtl. Grafiken, Prototypen, Beispiele)
  • Entwurfsbegründungen
  • Optionen zur Weiterentwicklung
  • Appendices und Referenzen

 

Form der Dokumentation

  • Gegliederte Struktur
  • Einleitung mit kurzer Erläuterung der Aufgabenstellung und Zielsetzung
  • Hauptteil mit Darstellung der Entwürfe und Begründung der Entwurfsentscheidungen; enthält evtl. grafische Darstellungen und Screenshots; Hinweise auf Appendices (Normdateien und Schemata); Fakten in knapper Form darstellen
  • Schlussteil mit Perspektiven zur Weiterentwicklung
  • Anhang: Appendices und Referenzen

 

Erstellen der Dokumentation

  • Anforderungsspezifikation als Leitfaden benutzen
  • Fragen und kritische Punkte sammeln und ordnen
  • eine Gliederung entwickeln
  • Zwischenschritte bei den Entwurfsentscheidungen festhalten, falls Entscheidungen revidiert werden müssen

Beispiele

 

Quelle: Materialien leicht verändert übernommen von Jutta Lindenthal
Präsentation: Was gehört zur Dokumentation auf der Projektwebsite von Ursula Schulz unter http://www.bui.haw-hamburg.de/pers/ursula.schulz/textweb/dokumentation/Dokumentation.htm