Dokumentendefinition

Nach abgeschlossener Inhaltsmodellierung, Modellverfeinerung und Vorlagendefinition, dient die Dokumentendefinition als letzter Schritt im Konfigurationsentwurfsprozess der Gestaltung eines, in der Regel benötigten, Ergebnisdokuments. Dieses sollte eine gemäß Ihres Corporate Design definierte Struktur und Optik aufweisen und die Inhalte (d.h. konkrete Elemente eines bestimmten Inhaltstyps), die Sie im Rahmen Ihrer auf besagter Konfiguration basierender Projekte erarbeiten, adäquat präsentieren. In diesem Zusammenhang beschäftigt sich die Dokumentendefinition mit

  • der gewünschten Kapitelstruktur zur Untergliederung des Dokuments
  • dem Layout und visuellen Erscheinungsbild des Dokuments
  • der konkreten Darstellung einzelner Inhaltselemente mittels grafischer, textueller und/oder tabellarischer Beschreibungen

Die Definition einer Dokumentenvorlage selbst erfolgt in MS Word® und bedient sich des Konzepts sogenannter Marker (auch Tags genannt). Diese sind in der Vorlage zwischen je drei Hashtags vor und nach dem Marker eingebettet und werden als Platzhalter bei der Generierung des Ergebnisdokuments im Plug-in durch die eigentliche Beschreibung der Inhaltselemente und Metainformationen ersetzt.

Hinweis:  Die automatisch an Stelle der Marker eingefügten Beschreibungsinhalte werden (auch innerhalb von Tabellen) immer mit Hilfe der Formatvorlage „Standard“ formatiert. Daher sollte diese Formatvorlage gemäß Ihres Corporate Design immer angemessen definiert sein.

Vor diesem Hintergrund ist es hilfreich, sich vorab die Struktur des Inhalts des Ergebnisdokuments auf Basis des zuvor erstellten Inhaltsmodells zu überlegen und dabei wie folgt vorzugehen, um eine entsprechende Vorlage für dieses Ergebnisdokument zu definieren:

  1. Starten Sie MS Word® und öffnen ein neues bzw. leeres Dokument. Falls Sie bereits eine unternehmensspezifische Dokumentenvorlage für das Ergebnisdokument haben, können Sie alternativ diese öffnen.
  1. Erstellen Sie eine Kapitelstruktur mit Überschriften für das Ergebnisdokument anhand derjenigen Inhaltstypen, deren konkrete Inhaltselemente Sie explizit im Ergebnisdokument aufführen möchten. Dabei legen Sie für jede dieser Kategorien mindestens einen logischen Abschnitt an bzw. verteilen sie auf separate Kapitel in Ihrer Dokumentenvorlage und legen dabei fest, wo die entsprechenden Inhaltselemente eingeordnet werden.
    • Inhaltstypen, deren Elemente nur als Zwischenprodukt im Projektverlauf dazu dienen, andere Inhalte zu erschließen, können außer Acht gelassen werden.
    • Ein Inhaltselement kann auch in mehreren Abschnitten aufgeführt werden, z.B. in einem Abschnitt als Teil eines tabellarischen oder listenartigen Überblicks und in einem anderen Abschnitt als detaillierte, textuelle oder grafische Beschreibung.
  1. Ergänzen Sie die üblichen Dokumentbestandteile wie Deckblatt, Anhang sowie Inhalts-, Tabellen- und Abbildungsverzeichnis und formatieren Sie Schriftart, Absätze, Überschriften gemäß Ihres Corporate Design.
Abbildung 28. Dokumentenvorlage mit ReqSuite®-Markern für das Deckblatt (links) und Hinweisblatt (rechts) eines beispielhaften Projektlastenheftes
  1. Legen Sie die konkrete Darstellungsweise von Inhalten eines Inhaltstyps im Ergebnisdokument fest. Dabei stehen folgende komplementäre Optionen zur Auswahl, die sich gegenseitig nicht ausschließen:
    • Teil einer Liste: Inhaltselemente werden in Form einer Spiegelstrichliste mit kommaseparierten Attributwerten ausgegeben.
    • Teil einer Tabelle: Inhaltselemente werden tabellarisch gemäß Formatvorlage ausgegeben, die Sie im geöffneten Word®-Dokument mit dem Namen „ReqSuiteDynamicTableTemplate“ hinterlegenden können. Diese Tabellenvorlage soll gemäß Ihres Corporate Designs so gestaltet sein, dass Sie anschaulich verschiedene Inhalte eines Inhaltstyps repräsentiert, wobei die Spalten der Tabelle Attribute eines Inhaltselements darstellen (z.B. Name, Beschreibung, etc.).
    • Eigenständige Detailbeschreibung: Inhaltselemente werden separat in Form eines Absatzes oder einer Tabelle dargestellt. Im Falle einer Tabelle können Sie im geöffneten Word®-Dokument eine Formatvorlage mit den Namen „ReqSuiteTableTemplate“ hinterlegen. Diese Tabellenvorlage soll gemäß Ihres Corporate Designs so gestaltet sein, dass Sie anschaulich die einzelnen Attribute eines Inhaltselements repräsentieren, wobei jede Zeile der Tabelle ein Attribut darstellt.
    • Eigenständige Detailvisualisierung: Inhaltselemente werden durch eine grafische Beschreibung mittels der für Sie hinterlegten Notation (z.B. mit Hilfe eines Diagramms) repräsentiert ausgegeben. Legen Sie dazu eine Formatvorlage für Texte mit dem Namen „ReqSuiteCaption“ an, um Bildunterschriften gemäß Ihres Corporate Design zu formatieren.
    • Teil einer Überblicksgrafik: Inhaltselemente werden als Teil einer Grafik zur visuellen Beschreibung von Zusammenhängen aller Inhaltselemente einer Inhaltskategorie ausgegeben. Legen Sie dazu eine Formatvorlage für Texte mit dem Namen „ReqSuiteCaption“ an, um Bildunterschriften gemäß Ihres Corporate Design zu formatieren.
    • Überschriften: Zusätzlich können Sie beliebige Ihrem Corporate Design entsprechende Formatvorlagen mit frei wählbarem Namen (ohne Sonderzeichen) definieren und diese im Zusammenhang mit bestimmten Dokumentenmarkern verwenden und zwar an all denjenigen Stellen, wo eine Formatvorlage explizit zugewiesen werden kann (siehe Abbildung 32).
  1. Setzen Sie nun entsprechende Marker sinngemäß an all diejenigen Stellen in den einzelnen Abschnitten der Vorlage, wo jene im Zuge späterer Dokumentgenerierung durch die eigentliche Beschreibung der Inhaltselemente gemäß Abbildung 31 ersetzt werden sollen. Den konkreten Einsatz von komplexeren Markern können Sie der Beispielvorlage in Abbildung 29 entnehmen.
Abbildung 29. Ausschnitt einer Dokumentenvorlage mit komplexeren ReqSuite®-Markern in MS Word®
  1. Speichern Sie das geöffnete Word®-Dokument und schließen Sie es. Um die Vorlage für die Projektkonfiguration wirksam zu hinterlegen, d.h. um aus der soeben definierten Dokumentvorlage ein Ergebnisdokument im Rahmen eines geöffneten Projekts generieren zu können, folgen Sie den Anweisungen zum Hochladen einer Dokumentenvorlage in der Konfigurationsverwaltung (siehe auch Abbildung 30).
Abbildung 30. Verwaltung der für eine Konfiguration hinterlegten Dokumentenvorlagen

Mit dem Einspielen der Dokumentenvorlage über die WebApp ins ReqSuite®-System ist der Konfigurationsentwurfsprozess soweit vollständig abgeschlossen. Jedes Projekt, für das Sie die soeben vollendete Konfiguration in der Projektverwaltung definieren, wird von nun an über alle Einzelheiten der Konfigurationsspezifikation verfügen. Dies gilt auch für alle bestehenden Projekte, die bereits vor Abschluss des Konfigurationsprozesses auf dieser Projektkonfiguration basierten, unter der Voraussetzung, dass Sie die Projektkonfiguration aktualisieren.

Nachfolgend sei eine Übersicht über alle in ReqSuite® verwendbaren Dokumentenmarker – eingeteilt in das Projekt allgemein umschreibende „Meta-Marker“ und projektinhaltspezifische „Inhalts-Marker“- samt erklärender Beschreibung zum ins Dokument einzufügenden Inhalt gegeben.

Abbildung 31. Übersicht aller ReqSuite®-Meta-Marker für Dokumentvorlagen
Abbildung 32. Übersicht aller ReqSuite®-Inhalts-Marker für Dokumentvorlagen

Legende zu Abbildung 31 und 32:
<…>     Variable
(…)       Optional
{… | …}   Alternativen
[…]       reguläre Klammern als Teil von Filtern

Hinweis:  Sie können jede der zuvor geschilderten Modellierungs- und Definitionsschritte auch nachträglich und wiederholt ausführen, um Ihre Projektkonfiguration z.B. an veränderten Projektbedingungen anzupassen. Im Falle mehrerer Projekte, die auf derselben Konfiguration basieren, sei jedoch empfohlen, anstelle einer Anpassung der bestehenden Konfiguration, die Erstellung einer neuen Konfiguration anzustreben.