SOS – Wie Sie Oberwasser im Dokumentenmanagement behalten

Zu den Haupttätigkeiten eines Requirements Engineers zählt das Dokumentieren von Anforderungen an ein geplantes System. Er pflegt meist als Einziger einen direkten Kontakt zu allen beteiligten Stakeholdern und muss die Bedürfnisse hinter ihren Aussagen erkennen und verstehen. Anschließend werden diese Informationen so aufbereitet, dass auch fachfremde Entwickler sie nachvollziehen und umsetzen können.
Es häufen sich daher die unterschiedlichsten Informationen an, die am Ende strukturiert, verständlich und übersichtlich in ein Schriftstück aufgenommen werden sollen. Eine schmucke Umrandung zum Beispiel mit Deckblatt, Einleitung und Glossar soll darüber hinaus für eine ansprechende Professionalität sorgen. Schnell kann man da schon einmal den Überblick verlieren und durch eine Welle an Schriftstücken und Revisionen untergehen. Doch lassen Sie es erst gar nicht so weit kommen: Vorhang auf, objectiF RPM.

Nutzen Sie unser Tool, um all Ihre notwendigen Dokumente zu generieren. Die Dokumentenerstellung ist sehr flexibel und zudem so leicht wiederverwendbar, dass Sie später in Windeseile eigene Dokumente und Varianten auf Knopfdruck erzeugen können. Einmal damit vertraut, bietet der Generierungsmechanismus jedem Anwender eine Vielzahl an Möglichkeiten.
Übrigens, wenn Sie im Dokumentenwirrwarr eine Orientierung hinsichtlich der Dokumentation von Softwareanforderungen benötigen, bietet sich unter anderem ein Blick in die Norm ISO/IEEE-Standard 29148:2011 an.

Vorlagen in objectiF RPM nutzen

Für Ihre Projektinhalte stehen in objectiF RPM bereits eine Reihe an MS Word-Vorlagen zur Verfügung, die Sie entweder unverändert übernehmen oder nach eigenem Geschmack anpassen und mit Projektinhalten füllen können.
Folgende Dokumentvorlagen finden sich bereits in objectiF RPM wieder.

• Anforderungsdefinition: Beinhaltet Dokumentvorlagen, die sich Anforderungen aller Art (Qualitätsanforderungen, funktionale Anforderungen etc.), Akteure, Zielgruppen und Anwendungsfälle eines Packages beziehen
• Backlog und Sprint Status: Beinhaltet Vorlagen, die sich auf die Projektaufgaben – welche im kommenden Sprint erledigt werden sollen – beziehen. Ferner enthalten sind Vorlagen für alle gesammelten Anforderungen an die Software
• Lastenheft: Enthält Kapitel anlehnend an der ISO/IEC/IEEE 29148:2011
• Systemarchitektur: Enthält Dokumentvorlagen für Systembausteine, Schnittstellenübersicht und Daten des Systems sowie die Anforderungsverfolgung
• Vision-Dokument:  Die Vision des Projekts steht hier im Vordergrund. Dazu gehören auch Dokumentvorlagen für Produktmerkmale und generelle Rahmenbedingungen aber auch grundlegende Ziele sowie beteiligte Stakeholder
• Ziele und Kontext: Systemkontextdiagramme und die Abgrenzung des Systems, Ziele des Systems und ihre Beziehungen sowie alle beteiligten Stakeholder stehen hier im Rampenlicht

Unsere Vorlagen enthalten dazu jeweils mindestens ein anpassbares Deckblatt, eine Einleitung, Inhalts-, Abbildungs- und Tabellenverzeichnis sowie ein Glossar. Sie finden die bereitgestellten Vorlagen unter Einstellungen anzeigen > Dokumentvorlagen.

Dokumentation und Bausteine

Mit objectiF RPM sind Sie sehr flexibel unterwegs: Sie können zum Beispiel Vorlagen auch für einzelne Kapitel, Abschnitte, Diagramme, Abfragen und / oder Artefakteigenschaften oder sonstige individuelle, kleinteilige Informationsbausteine eigenständig erstellen. So ist es Ihnen möglich, Dokumente modular zusammenbauen, um beispielsweise unterschiedliche Dokumentvarianten zu bilden. Bei Änderungen oder Varianten muss dann nur das jeweilige Informationsmodul angepasst werden.
Unser Blogbeitrag „Das Bausteinprinzip für die Projektdokumentation“ hat diese Thematik und ihre Vorteile bereits umfassend beleuchtet. Daher verweise ich zur eingehenden Lektüre gern noch einmal darauf. Doch heute zeige ich Ihnen diese modulare Vorgehensweise einmal in der Praxis…

Dokument erzeugen – Fallbeispiel “Offene Punkte-Liste eines Meetings”

Montagvormittag. Der Requirements Engineer kontaktiert alle möglichen Stakeholder. Spannende Diskussionen stehen an – und am Ende hat der Requirements Engineer durch eine Reihe an Befragungstechniken auch eine umfassende To do-Liste beisammen, beispielsweise mit Anforderungen, die noch geprüft, aufgenommen oder präzisiert bzw. in feinere zerlegt werden müssen. All diese Informationen könnten nun natürlich in ein Word- oder Excel-Dokument niedergeschrieben werden. Aber warum sich regelmäßig solch unnötige Arbeit machen, wenn es auch leichter und automatisiert gehen kann? Warum nicht ein zentrales Tool nutzen, das unter anderem genau darauf ausgelegt ist und die Inhalte am Ende per Knopfdruck in ein Dokument überträgt?

Wenn Sie nun mit objectiF RPM arbeiten, sind Sie fein raus. Das Erzeugen von Dokumenten auf Basis von modularen Dokumentvorlagen geht damit ruckzuck – und für alles andere können Sie selbst die Konfiguration übernehmen. So erging es nämlich einem unserer Kunden, der objectiF RPM per Konfiguration so erweitert hat, dass er offene Punkte per Formular erfassen und diese per Abfrage darstellen konnte. Neben den beteiligten Stakeholdern, inklusive der Kontaktdaten (Telefon, E-Mail, Verfügbarkeit) hatte der Kunde noch die Priorität des offenen Punktes sowie eine kurze Inhaltsbeschreibung und den zuständige Mitarbeiter erfasst. Wie individuelle Artefakte in objectiF RPM anlegt werden, haben wir bereits in der Vergangenheit ausführlich beschrieben. Und auch der Formulardesigner kam bereits in einem Blogbeitrag zur Sprache.

Nun wollte der Kunde diese offenen Punkte aber noch in ein kleines Dokument ausgeben, das zusätzlich über das Tool an alle relevanten Stakeholder verschickt wird. Unser Support stand ihm dabei mit Rat und Tat zur Seite – und ich zeige Ihnen heute wie Sie diese einfachen Handgriffe in objectiF RPM vornehmen können.

Auf geht‘s zum eigenen Dokument in vier kleinen Schritten – Vorbemerkung

Im Sinne des bereits zitierten „Bausteinprinzips“ brauche ich dazu mehrere Dokumentvorlagen (Templates), die im Anschluss zu einem Gesamtdokument zusammenfügt werden. Zusätzlich gebe ich dem Dokument noch einen schmucken Rahmen mit Deckblatt und Einleitung hinzu.

Prinzipiell sind jetzt 4 Schritte notwendig (die sich aber zum Teil wiederholen, wodurch der Aufwand klein gehalten wird):

1. Ich erstelle eine Dokumentenvorlage, die die offenen Punkte bzw. deren Inhalte ausgibt: das wäre in meinem Fall eine Beschreibung, die Priorität, den zuständigen Mitarbeiter und Stakeholder; übersichtlich dargestellt, zum Beispiel in Form einer kleinen Tabelle
2. Ich erstelle eine Dokumentenvorlage, die den ausgewählten Stakeholder sowie seine Kontaktdaten ausgibt
3. Ich erstelle eine Dokumentenvorlage, welche die beiden oberen Templates dazu „benutzt“, die Inhalte zusammenfassend in Form einer Auflistung darzustellen
4. Ich erzeuge das finale Word-Dokument basierend auf diesen drei Dokumentenvorlagen

Das Ergebnis könnte dann zum Beispiel so aussehen: Eine Tabelle, in der die in objectiF RPM eingetragenen oder geänderten Informationen bei jeder Generierung neu transferiert werden:

Auf geht‘s zum eigenen Dokument – Schritt 1

Beim Erstellen eines Gesamtdokuments gehe ich zunächst vom kleinsten Inhalt aus. Daher lege ich zuerst über das Kontextmenü weitere anlegen … > Dokumentvorlage in einem Package eine neue Dokumentvorlage an, die die Inhalte der offenen Punkte beinhalten soll. Der Name kann dabei frei gewählt werden, bei mir heißt das Template jetzt mal Offene Punkte Detail. Beim Anlegen gebe ich im Bearbeitungsdialog noch das passende Artefakt für die offene Punkte als Stereotypen an.

Sobald ich die Dokumentenvorlage erstellt habe, öffne ich mit Rechtsklick das Kontextmenü und wähle Bearbeiten. Es öffnet sich sogleich eine Word-Datei. Das Template mit Inhalt zu füllen, ist ziemlich leicht. Zunächst gebe ich den optischen Rahmen vor: Layout und sonstige Gestaltungsmittel nehme ich grundsätzlich immer direkt im Word-Dokument vor. Das können Tabellen, Schriftarten und -größen und sonstige Formatierungen sein.
Den eigentlichen Inhalt aus objectiF RPM erzeuge ich dann anschließend über den Textmarkeneditor. Für jede Eigenschaft bzw. Abfrage/Auflistung füge ich die entsprechende Textmarke in der Vorlage ein. Und das geht so:

1. Cursor im Dokument an der gewünschten Stelle platzieren
2. Eigenschaft oder Abfrage/Auflistung im Textmarkeneditor wählen (zum Beispiel [Beschreibung] oder [Priorität])
3.  Über den Button Einfügen wird die Textmarke in der Vorlage platziert

Also drei kleine Schritte, die ich für alle Eigenschaften/Auflistungen wiederhole.

Ich habe hierzu in Word eine kleine Tabelle erzeugt. Alle fett markierten Wörter wurden direkt in Word eingetragen, die dazugehörigen Eigenschaften (an den eckigen Klammern zu erkennen) wurden über das Textmarker-Feld eingebunden. Jetzt speichere ich die Vorlage gewohnt ab und schließe das Fenster.

Auf geht‘s zum eigenen Dokument – Schritt 2

Jetzt möchte ich innerhalb Tabelle aus Schritt 1 noch die Informationen zu den Stakeholdern übermitteln. Dazu erstelle ich eine zweite Dokumentenvorlage, bevor ich die Verknüpfung vornehme. Über das Kontextmenü lege ich eine neue Vorlage an, die ich Offene Punkte zu den Stakeholdern bezeichnet habe. Als Stereotypen wähle ich noch die passende Artefakt-Beziehung aus. Anschließend öffne ich die Dokumentenvorlage wieder über das Kontextmenü mit dem Befehl Bearbeiten.

Neben dem obligatorischen Namen des Stakeholders werden – wie bei unserem Kunden – die Kontaktdaten (Telefon, E-Mail und Verfügbarkeit) verknüpft. Weitere Inhalte könnten aber zum Beispiel noch Adresse, Beschreibung, Einfluss, Wissensgebiet oder Anforderungen des Stakeholders sein.
Hierzu gehe ich ganz genauso wie in Schritt 1 beschrieben vor: Ich gebe der Word-Datei wieder einen textlichen Rahmen vor und arbeite anschließend wieder mit dem Textmarkeneditor, um die Eigenschaften/Auflistungen an der gewünschten Stelle hinzuzufügen. Der Name des Stakeholders wird hierbei  über die Eigenschaft [Stakeholder (Ziel-Element).Name] erzeugt. Zur Ausgabe der in objectiF RPM hinterlegten Telefonnummer muss lediglich [Stakeholder (Ziel-Element).Telefon] über den Textmarkeneditor hinzugefügt werden. Diese Eigenschaften liefert objectiF RPM wieder von Haus aus mit.

Die Dokumentenvorlage könnte dann folgendermaßen aussehen:

Jetzt nur noch abspeichern und fertig ist mein nächstes Template. Abschließend setze ich dieses nur noch in die Dokumentenvorlage aus Schritt 1 in Beziehung. Dazu wähle ich in Word an der gewünschten Stelle die Artefaktbeziehung [Offene Punkte – Stakeholder-Beziehung (Artefaktbeziehungen)] im Textmarkeneditor aus und wähle die eben Dokumentenvorlage aus Schritt 2. Über Einfügen habe ich die Verknüpfung sogleich erzeugt.

Auf geht‘s zum eigenen Dokument – Schritt 3

Jetzt erstelle ich noch eine dritte und letzte Dokumentenvorlage. Im späteren Dokument soll ja nicht nur ein offener Punkt wiedergeben werden, sondern alle, die in objectiF RPM per Formular angelegt wurden. Ich nenne diese Vorlage daher einfach mal Offene Punkte alle. Und da die offenen Punkte im finalen Dokument als Auflistung erscheinen sollen, klicke ich im Textmarkeneditor auf Auflistung. Dort wähle ich im Drop Down-Menü bei Auflistung wieder das entsprechende Artefakt aus.

Die Inhalte bezieht diese Dokumentenvorlage nun aus der Vorlage aus Schritt 1 (Sie erinnern sich, das ist die mit den angelegten Eigenschaften Beschreibung, Zuständigkeit und Priorität sowie den Stakeholdern). Daher wähle ich hier unser Template aus Schritt 1 aus.
Sie sehen also, ich baue das neue Dokument somit Stück für Stück zusammen. Jetzt wieder auf Einfügen klicken und es sollte so aussehen:

Nur noch abgespeichert und das Fenster kann wieder geschlossen werden.

Damit habe ich nun (fast) alles was wir brauchen, um das endgültige Dokument zu erzeugen:

1. eine Dokumentenvorlage, die die spezifischen Eigenschaften anspricht (Offene Punkte Detail),
2. eine, welche die Verbindung zu den im Tool angelegten Stakeholdern herstellt (Offene Punkte zu den Stakeholdern)
3. eine, die alle Informationen aufgreift (Offene Punkte alle) und im Dokument als Auflistung wiedergibt

Auf Basis dieser drei Dokumentenvorlagen kann ich nun mehrfach – und auf Knopfdruck – immer wieder Dokumente zu den offenen Punkten anlegen, um beispielsweise Versionen oder Varianten davon zu erzeugen. Und noch ein großer Vorteil: wenn ich an den Vorlagen kleinere inhaltliche als auch optische Änderungen vornehme, wirkt sich das gleich auf das Gesamtdokument aus. Langwierige und manuelle Änderungen an allen Informationsprodukten sind damit zum Glück passé.

Auf geht‘s zum eigenen Dokument – Schritt 4

Jetzt zeige ich Ihnen noch wie unser Kunde aus den zuvor erzeugten Dokumentvorlagen das finale Dokument zusammengebaut hat. Das Erstellen geht ganz schnell: Einfach in einem Package per Kontextmenü auf Anlegen … > Dokument klicken.

Es öffnet sich ein neues Dialogfenster. Hier geben Sie dem künftigen Dokument einen Namen und wählen die hierarchisch gesehen höchste Dokumentenvorlage aus. Das wäre in unserem Beispiel die aus Schritt 3. Jetzt nur noch das Package angeben, aus der das Dokument seine Inhalte bezieht und fertig ist es.

Um das Dokument mit den Inhalten zu generieren, genügen nun zwei Klicks und objectiF RPM füllt die Textmarken an definierter Stelle selbstständig mit den Projektdaten. Dazu öffne auf dem Dokument mit einem Rechtsklick das Kontextmenü und wähle Inhalt generieren. Mit Anzeigen in Word oder Anzeigen als PDF schaue ich mir das fertige Dokument anschließend an.
Bei jeder Änderung, sowohl an den Dokumentvorlagen als auch beim Anlegen neuer Inhalte, muss das Dokument auf diese Weise neu generiert werden, weil nur so die Inhalte im Gesamtdokument auch aktualisiert werden.

Das finale Dokument

So, unser Dokument wäre damit (nahezu) fertig. Ich habe den offenen Punkten noch ein Deckblatt sowie eine kurze Einleitung vorangestellt und am Ende ein Glossar angehangen.

Sie können dazu übrigens unsere umfangreichen Vorlagen nutzen oder das Dokument wie ich mit wenigen Klicks selbst zusammenstellen und gestalten. Denn das Beste: objectiF RPM ist in der Hinsicht komplett anpassbar und flexibel – und zwar nicht nur die Eigenschaften, die ich in den vorangegangenen Schritten vergeben habe, sondern auch vieles Weitere kann nach Herzenslust justiert werden.
Werden Sie daher doch einfach mal selbst kreativ. Und sollte wider Erwarten mal etwas nicht auf den ersten Blick umsetzbar sein, dann wenden Sie sich gerne an uns.

Das Dokument versenden

Zu guter Letzt möchte ich das Dokument natürlich noch an meine Kollegen weiterleiten. Dazu habe ich nun die Wahl: Entweder kann ich das Dokument direkt aus dem Tool heraus teilen oder es ganz klassisch als Word- bzw. PDF-Datei abspeichern und extern als E-Mail verschicken. Ich entscheide mich für die Möglichkeit über unser Tool.

Dazu verwende ich den Befehl Teilen über das Kontextmenü, und Verlinkungen zu fast jedem Projektelement (also nicht nur zu Dokumenten) werden anschließend bequem an die Stakeholder oder Teammitglieder verschickt. Das geschieht entweder per E-Mail, Hyperlink oder Link-Datei. Der Empfänger kann dann über den Link auf das Element zugreifen, es einsehen oder – je nach Rechtevergabe – auch bearbeiten.

Automatische Dokumentengenerierung über den Task Manager

Zum Schluss noch ein praktischer Tipp: In objectiF RPM können die Dokumente auch über den im Tool integrierten Task Manager automatisch bzw. zu festgelegten Zeiten generiert werden. So ist das Dokument beispielweise morgens immer auf dem aktuellsten Stand, wenn das Intervall auf abends eingestellt wurde.

So gehe ich vor: Ich begebe mich hierzu in das Backstage-Menü von objectiF RPM und wähle Projekt > Task Manager.

Es öffnet sich ein neues Dialog-Fenster, in dem die entsprechenden Schritte bzw. Einstellungen vorngenommen werden. Neben dem Task Dokument generieren gebe ich noch einen Namen, die Uhrzeit und das Intervall an (z.B. wöchentlich oder pro Arbeitstag). Jetzt muss ich nur noch bestätigen.

Fazit

Die Dokumentengenerierung ist ein wesentlicher Bestandteil des Anforderungsmanagements – und objectiF RPM unterstützt Sie umfassend dabei. Neben den bereits mitgelieferten und verwendbaren Vorlagen können Sie diese auch modifizieren oder komplett eigene Templates erstellen und somit Ihre ganz persönlichen Inhalte und Dokumente nach dem Bausteinprinzip erzeugen (zum Beispiel auch basierend auf Ihrem Corporate Design). Das Tool ist dahingehend sehr flexibel und anpassbar. Auch unterstützt es Sie bei einer automatischen Dokumentengenerierung über den Task Manager, sodass Ihre Dokumente immer auf dem neuesten Stand sind.

Wollen Sie jetzt gleich einmal loslegen? Dann ran ans Werk und werden Sie tätig. Einmal mit dem Generierungsmechanismus vertraut, werden Sie Ihre Dokumente später auf Knopfdruck zusammenbauen.
Noch kein objectiF RPM-Kunde? Dann lege ich Ihnen unsere kostenlose Trial-Version ans Herz.