Wie können teilautomatisiert erstellte Dokumente effizient gereviewt werden?

1. Einleitung

Technische Dokumente, die teilautomatisiert erstellt wurden, sind oft sehr umfangreich. Bei der Entwicklung eines Produkts nach dem V-Modell entstehen unter anderem die folgenden technischen Dokumente:

• Designspezifikationen,
• Analysedokumente,
• Anforderungsdokumente,
• Testspezifikationen und Testberichte.

Dokumentenreviews dienen dazu, Lücken und systematische Fehler in den Dokumenten aufzudecken. Dieser Beitrag zeigt, wie das Review technischer Dokumente effektiv und effizient gestaltet werden kann.

2. Effektives und effizientes Review technischer Dokumente

Ein Review kann in zwei Formen erfolgen:

• Walk-through-Review: Der Autor führt die Teilnehmer durch das Dokument.
• Inspection-Review: Jeder Teilnehmer liest das Dokument eigenständig.

Schritte zur optimalen Review-Vorbereitung

„Ein erfolgreiches Review hängt von der Auswahl der richtigen Teilnehmer und der präzisen Vorbereitung ab.“

Für jedes Kapitel oder jeden Abschnitt des Dokuments sollte ermittelt werden:

• Wer ist Verantwortlicher für den Inhalt?
• Wer ist „projektinterner Kunde“, der die Inhalte benötigt?

Abschnitte ohne „projektinterne Kunden“ sollten gestrichen werden. Die Review-Kriterien werden vom Review-Team gemeinsam festgelegt, um sicherzustellen, dass ein gemeinsames Verständnis vorhanden ist und alle relevanten Aspekte geprüft werden.

Durchführung des Reviews

Das Review sollte wie folgt organisiert werden:

• Aufteilung des Dokuments in Review-Abschnitte,
• Zuweisung der Review-Abschnitte an mehr als einen Review-Teilnehmer, bevorzugt die „projektinternen Kunden“ des jeweiligen Review-Abschnitts,
• Nach Erhalt aller Review-Kommentare: Diskussion der Review-Kommentare in einer gemeinsamen Sitzung der Review-Teilnehmer, um die notwendigen Korrekturen festzulegen.

Nach Einarbeitung aller Korrekturen kann das Dokument freigegeben werden.

3. Vorteile teilautomatisiert erstellter Dokumente

Teilautomatisiert erstellte Dokumente weisen folgende Vorteile auf:

• Konsistente Struktur: Die Dokumentengliederung ist vorgegeben.
• Automatische Fehlererkennung: Fehlende oder inkonsistente Einträge werden softwaregestützt identifiziert.
• Frei von Rechtschreibfehlern: Autogenerierte Texte sind standardisiert.

„Trivialfehler wie fehlende Einträge oder inkonsistente Verknüpfungen werden vor dem Review durch Software erkannt.“

Grenzen der Automatisierung

Bestimmte Fehler können nur manuell erkannt werden, wie:

• Fehlerhafte Annahmen (z. B. maximale Störeinflüsse),
• Suboptimale Designentscheidungen (z. B. in der Systemarchitektur).

4. Zusammenfassung

Das Review technischer Dokumente kann effizient gestaltet werden, indem:

• vorrangig die „projektinternen Kunden“ als Review-Teilnehmer eingebunden werden,
• Abschnitte ohne „projektinterne Kunden“ gestrichen werden,
• Review-Kriterien im Vorfeld durch das Review-Team abgestimmt werden und sich nur auf das beziehen, was nicht automatisiert geprüft und korrigiert werden kann.

Die autoConform®-Software unterstützt den Reviewprozess, indem sie Trivialfehler erkennt und konsistente Verknüpfungen sicherstellt. Dadurch können sich die Review-Teilnehmer auf inhaltliche Fehler konzentrieren und ihren Zeitaufwand minimieren.