Das Bausteinprinzip für die Projektdokumentation

Mit Bausteinen wie LEGO kann man vieles machen. Zum Beispiel eine neue Geschäftsstrategie entwickeln, wie Julian Kea vor einiger Zeit in unserem Blog vorgestellt hat. Aber es geht noch mehr. Nun gut, Sie arbeiten nicht mit wirklichen LEGO-Bausteinen, dafür wenden Sie das gleiche Prinzip an: Nämlich Stück für Stück etwas zusammenzubauen. Und zwar die Dokumentation in Ihren Projekten, also beispielsweise ein Lastenheft oder ein Dokument mit der Projektvision. Durch dieses Bausteinprinzip können Sie sich Dokumente ganz flexibel zusammenstellen und u. a. Varianten ohne großen Aufwand bilden. Diese Vorgehensweise finden Sie in unserer Application Lifecycle Management-Lösung objectiF RPM. Ich möchte Ihnen heute vorstellen, wie das funktioniert.

Rosa oder gelb? Auch für die Erstellung von Dokumenten müssen Sie unterschiedliche Varianten berücksichtigen.

Der Baukasten: Dokumentvorlagen in Word

Um Dokumente zu erzeugen, arbeiten Sie in objectiF RPM in zwei grundlegenden Schritten: Sie erstellen Vorlagen und erzeugen basierend auf diesen Vorlagen die Dokumente. Warum ist das so? Wenn Sie normalerweise ein neues MS Word-Dokument anlegen, dann erstellen Sie die Datei, überlegen sich Struktur und Inhalt und schreiben die einzelnen Kapitel “runter”. Dagegen ist erst einmal nichts einzuwenden, außer: Was passiert, wenn Sie z. B. 20 Dokumente haben und Ihr Unternehmen entscheidet, eine neue Schriftart in den Dokumenten zu verwenden? Müssen Sie jetzt alle 20 Dokumente einzeln anpassen? Wegen solchen Problemstellungen arbeiten MS Word-Spezialisten mit Vorlagen, in denen sie Struktur und Formatierungen festlegen und Dokumente darauf basierend erstellen. Auf diese Weise können Sie später die Schriftart in der Vorlage anpassen und alle darauf basierende Dokumente erhalten ebenfalls die angepasste Schriftart. Ziemlich praktisch.

Aber auch mit Vorlagen wird es immer dann spannend, wenn Sie Informationen wie einzelne Kapitel oder Abschnitte in anderen Dokumenten wiederverwenden möchten. Kopieren Sie diese manuell in alle Dokumente? Und wenn Sie dort einen Rechtschreibfehler finden, passen Sie wieder alle Dokumente manuell an? Um flexibel arbeiten zu können, lässt sich daher – von der Erstellungsseite betrachtet – ein umgekehrter Weg gehen:

Sie schreiben die einzelnen Kapitel in einzelne Dokumente und erzeugen aus diesen Kapiteln das gewünschte Zieldokument. Wie ein LEGO-Haus, das Sie sich aus den Bausteinen zusammenbauen. Hier sehen Sie, wie eine Anforderungsdokumentation in objectiF RPM aus den einzelnen Kapitelvorlagen “zusammengebaut” wurde und sich nun der Inhalt generieren lässt:

Eine Anforderungsdokumentation aus den einzelnen Bausteinen erzeugen

Dieses Prinzip hat sich bereits in anderen Berufsfeldern bewährt, in denen Sie viel und vor allem strukturiert schreiben müssen, z. B. in der technischen Redaktion. Dort begegnen Sie dem topic-orientierten Arbeiten: ein Topic entspricht einer in sich abgeschlossenen Beschreibung, einer Anleitung oder einer tabellarischen Referenz. Sie können sich dann diese Topics nicht nur flexibel zu unterschiedlichen Dokumenten zusammenstellen und Varianten erzeugen, sondern müssen bei Änderungen auch nur die betreffenden Bausteine anpassen – alle Zieldokumente passen sich automatisch daran an. Außerdem können Sie die Arbeit kapitelweise unter verschiedenen Leuten verteilen, sodass sich niemand in die Quere kommt.

Anforderungsdokumentation als Word-Datei

Von den Kapiteln bis zu den einzelnen Informationseinheiten

Aber nicht nur ganze Kapitel lassen sich vorbereiten und zu einem Gesamtdokument zusammenstellen. Sie können auch einzelne Abschnitte wiederverwenden oder noch sehr viel tiefer gehen und sich Dokumentvorlagen erschaffen, die nur eine Information beinhalten wie den Namen einer Anforderung oder den Namen des zugehörigen Testfalls. Dadurch kreieren Sie sich Informationsmodule, die Sie noch flexibler als Kapitel oder Abschnitte einsetzen können – z. B. in einer Tabelle, die die Informationen ganz nach Ihren Wünschen strukturiert. Das Beste mit objectiF RPM ist hier nun: diese Informationen sind in Ihren angelegten Artefakten wie Anforderungen oder Risiken als Eigenschaften gespeichert und Sie können sie dynamisch durch Platzhalter in die Dokumente generieren und wiederverwenden. Zum Beispiel haben Sie Ihren Anforderungen Testfälle zugeordnet, wie nachfolgend abgebildet:

Anforderungsdiagramm mit Anforderungen und Testfällen

Dann können Sie jetzt eine Tabelle definieren, die Name und Beschreibung einer Anforderung sowie zugeordnete Testfälle umfasst. objectiF RPM wendet diese Tabellenstruktur für jede Anforderung an. Das Ergebnis als PDF sieht beispielsweise folgendermaßen aus:

Generierte Liste der Anforderungen und zugehöriger Testfälle als PDF

Auch Diagramme sind kein Problem

Wer schon mit objectiF RPM arbeitet oder gearbeitet hat, weiß: Mit Diagrammen der UML oder SysML können Sie visuell Ziele, Anforderungen, Use Cases, Klassen oder Blöcke sowie ihre Beziehungen zueinander darstellen. Das sind wichtige Ergebnisse, die Sie mit anderen Projektmitarbeitern teilen müssen, um eine leicht verständliche Diskussionsgrundlage zu haben. Daher können Sie auch Diagramme wie Anforderungs- oder Anwendungsfalldiagramme Ihren Dokumenten leicht hinzufügen, ein einziger Platzhalter ist nur dafür notwendig. So sieht beispielsweise ein Zieldiagramm in einem MS Word-Dokument aus:

Ein Zieldiagramm, das in ein MS Word-Dokument generiert worden ist

Vorbereitete Dokumentvorlagen in objectiF RPM

Natürlich stellt objectiF RPM einige Dokumentvorlagen bereit, die Sie gleich nutzen oder an Ihre Bedürfnisse anpassen können. Dazu zählen folgende:

• Lastenheft: beinhaltet Kapitel anlehnend an der ISO/IEC/IEEE 29148:2011.
• Anforderungsdefinition: beinhaltet alle Anforderungen eines Packages Ihres Projekts.
• Backlog und Sprint Status: beinhaltet Backlogs mit Sprints und Sprints mit User Stories Ihres Projekts.
• Systemarchitektur: beinhaltet u. a. Systembausteine, Schnittstellenübersicht und Daten des Systems.
• Vision-Dokument: beinhaltet u. a. Stakeholder, Ziele und Vision Statement Ihres Projekts.
• Ziele und Kontext: beinhaltet u. a. Ziele und ihre Beziehungen sowie Systemkontextdiagramme Ihres Projekts.

Alle Dokumentvorlagen enthalten gleichzeitig Kapitel für Glossar, Abbildungs- und Tabellenverzeichnis. Kapitel für Stakeholder, Ziele, Anforderungen etc. sowie tabellarische Auswertungen mit den Beziehungen untereinander sind ebenfalls für Sie vorbereitet, sodass Sie diese in neuen Dokumenten übernehmen können.

Neugierig geworden? Schauen Sie doch mal bei unseren anderen Blog-Beiträgen vorbei, in denen wir konkrete Anwendungsfälle Schritt für Schritt im Tool durchführen:

• Zu allen Anforderungen die abgeleiteten und übergeordneten Anforderungen erstellen.
• Eine Tabelle, die eine Schnittstelle mit ihren Beziehungen und den Blöcken als Einheit darstellt, erstellen.

Oder laden Sie sich hier die kostenlose Testversion von objectiF RPM herunter. Ist das Prinzip der Dokumentationserstellung einmal im Kopf verankert, bauen auch Sie sich Ihre eigenen Dokumente ganz schnell!