Suche nach Begriffen

Lexikon

Begriff Definition
Dokumentation
  1. welche Dokumentarten
  2. welche Zielgruppen

 

Dokumentarten

  • Projektdokumentation
    • Projektdefinition
    • Projektplanung
    • Projektkontrolle
    • Projektauftrag
    • Projektabschlussbericht
    • Terminplan
    • Aufwand- / Kosten-Plan
    •  
  • Produktdokumentation
    • Pflichtenhefte
    • Leistungsbeschreibungen
    • Spezifikationen
    • Programmlistings
    • Benutzermanuale
    • Test- / Prüf-Unterlagen
    •  

Dokumentarten

ABB - Beispiel:

  • Bankdokumente
  • Kaufverträge
  • Miet-, Leasing-, Wartungs-, Lizenzverträge
  • Werkverträge, Dienstverträge
  • Arbeitsverträge
  • Alle anderen Rechtsverhältnisse

 

 

Q-Merkmale der Dokumentation

 

Konstruktive Massnahmen

Einfluss auf Qualitätskosten

Prüfumfang

Prüfmethode

Änderbarkeit

Ø Kennzeichnung aller Dok.teile – keine Redundanzen bei Verweisen

Ø Stichwortverzeichnis und Querverweise

Ø Einsatz Hilfsmittel zur Erstellung Dokumentation

Ø Bei schwerfälliger Änderbarkeit nicht überall nachgeführt – dadurch entstehen Folgefehler; Auslösung erheblicher Q-Kosten

Ø Stichproben

Ø  

Aktualität

Ø Installation geeigneter org. Massnahmen

Ø Erfüllung von Dokumentationsrichtlinien

Ø Nicht aktuelle Dok. Führt bei Fehlerbeseitigung zu Folgefehler: Auslösung erheblicher Q-Kosten

Ø Stichproben

Ø  

Eindeutigkeit (eines der diffizilsten Q-Merkmale bei Dok’s)

Ø Verwendung formaler Darstellungsmittel

Ø Missverständliche Formulierungen vermeiden

Ø Aussagen vermeiden, die nicht prüfbar sind

Ø Einheitliche Namensgebung wählen

Ø Geeignete Anzahl von Abstraktionsebenen wählen

Ø Nicht eindeutige Dok. Verursachen Probleme bei der Annahme; Auslösung erhöhter Q-Kosten

Ø Stichproben

Ø Checklisten

Identifizierbarkeit

Ø Verwendung von Kennzeichnungen gemäss Firmenkonvention

Ø Name des Autors / Prüfers / Freigebenden

Ø Erstellungs-, Prüf-, Freigabedatum

Ø Seitenanzahlen

Ø Version

Ø Nicht identifizierbare Dok. Werden letztendlich unbrauchbar; Auslösung beträchtlicher Q-Kosten

Ø Stichproben

Ø Checklisten

Normenkonformität

Ø Festlegungen von standardisierten Gliederungen

Ø Vorgabe Bezüglich Definition und Abkürzungen

Ø Vorgaben für den Quellcode, standardisierte Sprachelemente

Ø Verwendung standardisierter  Darstellungsmethoden

Ø Verstösse gegen Normenkonformität führen zu schlechter Portabilität; Auslösung erhöhter Q-Kosten

Ø Stichproben

Ø Checklisten

Verständlichkeit

Ø Vorgabe geeigneter Gliederungen

Ø Angaben zum Zweck des Dokumentes

Ø Zusammenhang/Verweise

Ø Definition aller Fachausdrücke

Ø Nicht verstandenes führt zu Folgefehler; Auslösung beträchtlicher Q-Kosten

Ø Stichproben

Ø 100%-ige Beseitigung der Fehler verlangt aber 100%-ige Prüfung!

Ø Checklisten

Vollständigkeit

Ø Vorgabe für Gliederungen

Ø Checklisten festlegen, welche Dok.-Inhalt beschreiben

Ø Rechnergestützte Dokumentationssysteme

Ø Definition aller Fachausdrücke

Ø Nicht vollständig bedeutet i.d.R. fehlende Funktionalität; Auslösung Q-Kosten häufig als Nachentwicklungskosten

Ø Stichproben

Ø Design-Review

Ø Walk through

Widerspruchsfreiheit

Ø Verwendung formaler Sprachen

Ø Verwendung formaler Darstellungsmittel

Ø Organisatorische Massnahmen wie Änderungsstelle für Dok./Programme

Ø Nicht vollständig bedeutet i.d.R. fehlende Funktionalität; Auslösung Q-Kosten häufig als Nachentwicklungskosten

Ø 100%-ige Prüfung, damit Widersprüche erkannt werden können

Ø organisatorische Massnahmen

 

Zugriffe - 496