Produktdokumention

Die Produktdokumentation umfasst das gesamte Wissen zu einem Produktinkrement. Sie beschreibt den Zustand eines Produktes zu einem bestimmten Zeitpunkt.

Zur Produktdokumentation zählen folgende Unterlagen

In der Systembeschreibung geht es konkret um den Versuch, das fachliche Produktwissen vollständig und widerspruchsfrei zu erfassen. Sie besteht aus der lückenlosen Dokumentation des Problemraumes, in dem sich die Nutzer des Systems bewegen, also aller Anwendungsfälle, Sonderfälle und Fehlerfälle der Funktionalität des Systems. Zu dieser Dokumentation gehören auch sogenannte “Verständnismodelle”, die wichtige Informationsobjekte und Nachrichten aus fachlicher Sicht erklären. Fachklassenmodelle und bei nachrichten-orientierten Systemen Nachrichtenmodelle ergänzen das Glossar und bilden gemeinsam die Grundlage für die gemeinsame Sprache im Projekt.

Die Architekturdefinition ist der Versuch, den durch die Systembeschreibung definierten Problemraum zu verstehen und durch Entscheidungen, Einschränkungen und Konzepten den Lösungsraum zu beschreiben. Sie besteht aus dem Architekturentwurf und der Beschreibung der Systemstruktur.

Ein Glossar ist eine alphabetisch sortierte Sammlung von Fachbegriffen aus dem Geschäftsfeld im Unternehmen, in dem die Software zum Einsatz kommt. Das Glossar ist das “Wörterbuch” des Projektes. Es ist ein Mini-Lexikon, zugeschnitten auf das Produkt.

Das Benutzerhandbuch ist das “Handbuch”, in dem die Bedienung der Software für die Nutzer beschrieben ist. Es enthält alle Informationen, die einem Nutzer helfen, das Produkt sicher und bestimmungsgemäß zu verwenden.

Das Betriebshandbuch ist das “Buch”, das dem wir erklären, wie ein Software-Produkt aus technischer Sicht (z.B. Sicherheit, Hardware, Netzwerk) funktioniert und beschreibt alle Aufgaben und Maßnahmen, die für den Betrieb eines IT-Systems notwendig sind.

Die Konfiguration eines Systems bestimmt das Zusammenspiel der Komponenten. Eine Konfiguration enthält umgebungsspezifische Einstellungen und Parameter zur Steuerung von Funktionalitäten. Eine Konfiguration gibt einen Überblick über die Unterschiede von Betriebsumgebungen.

Ein Skript automatisiert Abläufe bei der Bereitsstellung, Installation, Migration oder für den Betrieb von Software. Es ist ausführbares Wissen über Funktionen des Systems und deren Zusammenspiel.

Eine Schemadefinition ist ein Sammelbegriff für textbasierte Beschreibungssprachen zur Definition komplexer Datenstruktur in einem System. Schemadefinitionen werden zur Validierung von Daten benutzt. Es ist möglich, Schemadefinitionen zur Code-Generierung zu benutzen.

Code beantwortet die Frage, wie ein fachliches Problem gelöst wurde. Keine andere Form der Produktdokumentation ist exakter als lesbarer Code. Er ist als Dokumentation von Entwicklern für Entwickler eine unersetzliche Informationsquelle. Lesbarer Code ist arm an Kommentaren.

Ein Akzeptanztests oder auch Abnahmetests bezeichnet den Prozess der Überprüfung, dass ein Produktinkrement so funktioniert, wie sie in der Produktdokumentation beschrieben ist. Eine Benutzeroberfläche muss demnach alle im Benutzerhandbuch beschrieben Aktionen fehlerfrei ausführen. Eine Schnittstelle muss die Datenverarbeitung gemäß Schnittstellenbeschreibung korrekt und vollständig durchführen.

Der Begriff Integrationstest bezeichnet eine aufeinander abgestimmte Reihe von Einzeltests, die dazu dienen, verschiedene voneinander abhängige Komponenten eines komplexen Systems im Zusammenspiel miteinander zu testen. Für einen Integrationstest braucht man Kenntnisse über die technischen Schnittstellen zwischen den Komponenten.

Eine Produktdokumentation ist nicht auf das Wiki beschränkt. Die vollständige Dokumentation befindet sich in verschiedenen Medien, z.B.

  • Dokumentenmanagementsystem
  • Produktwissen im Wiki
  • Repository für Code und Test

Ziel eines agilen Projektes ist es, am Ende jedes Sprints ein vom Auftrageber potentiell nutzbares Produktinkrement zur Verfügung zu stellen. Es enthält nur jene Funktionalitäten, die bis zu diesem Zeitpunkt (das Ende des Sprints) im Backlog geplant, priorisiert und erfolgreich umgesetzt wurden. Die Produktdokumentation ist die exakt dazu passende Sammlung von fachlichem und technischem Wissen über das Produkt, das in der Anforderungsanalyse und während Realisierung und Test erarbeitet und verwendet wurde.


Wikipedia: Technische Dokumentation

Eine Technische Dokumentation (auch Technikdokumentation oder Produktdokumentation) umfasst alle Dokumente, die ein technisches Erzeugnis beschreiben. Sie bereitet die Informationen systematisch auf und strukturiert sie so, dass der jeweilige Zweck vollständig erfüllt wird. [..] Die Technische Dokumentation dient der Information und Instruktion definierter Zielgruppen, der haftungsrechtlichen Absicherung des Herstellers, der Produktbeobachtung, der Rückverfolgbarkeit und Reproduzierbarkeit sowie der dauerhaften bzw. gesetzlich geforderten Archivierung der relevanten Informationsinhalte. Die Bestandteile der Technischen Dokumentation bieten Informationen über das Produkt selbst, den Umgang mit ihm und über das Verhalten der Nutzer. Sie betrachten alle Lebensphasen des Produktes, von der Entwicklung bis zur Entsorgung, teilweise einschließlich der Herstellung der Vorprodukte.