+49 (30) 467086-20 service@microtool.de
Produkte » objectiF RM » Dokumentenmanagement » Dokument, Dokumentvorlagen, Kontextelemente

Dokument, Dokumentvorlagen, Kontextelemente

Dokumente wie Projektauftrag oder Lastenheft gehören in jedes Projekt und sind oft die Grundlage für die Kommunikation zwischen den Projektbeteiligten. Die Projektvorlagen in objectiF RM enthalten bereits fertige Dokumente und Dokumentvorlagen, die Sie nutzen oder an Ihre Bedürfnisse anpassen können. Wenn Sie sich mit der Dokumentengenerierung vertraut gemacht haben, können Sie auch Ihre eigenen Dokumente und Dokumentvorlagen erstellen.

Dokumentvorlagen

Dokumentvorlagen benötigen Sie, um Dokumente zu erstellen. Sie bestimmen den Inhalt und den Darstellung der Daten, die später in das Dokument generiert werden. Sind Dokumentvorlagen erst einmal angelegt, können Sie sie beliebig oft als Kapitel in einer (Haupt)Dokumentenvorlage verwenden. Beispiele dafür sind das Glossar sowie das Abbildungs- und Tabellenverzeichnis. Diese sind nur einmal angelegt und in jedem Dokument als referenziertes Kapitel eingebunden.

Um komplexe Dokumente zu erzeugen, benötigen Sie eine Reihe von Dokumentvorlagen, die am Ende durch verschiedene Kapitel zu einem Dokument zusammengeführt werden. Die Dokumentvorlagen gestalten Sie in MS Word. Beim Erstellen von Dokumenten und Dokumentvorlagen begegnen Ihnen vier Stereotypen:

  • Ein Dokument besitzt den Stereotypen «Document»
  • Dokumentvorlagen erkennen Sie am Stereotypen «DocumentTemplate»
  • Referenzierte Kapitel erhalten den Stereotypen «DocumentComposition» und
  • Kapitel, die in einer Dokumentvorlage referenziert werden, haben den Stereotypen «DocumentTemplateComposition».

Dokumente

Dokumente basieren auf Dokumentvorlagen. Über die Projektvorlagen stehen Ihnen in jedem Projekt folgende Dokumente zur Verfügung.

Sie können die Dokumente und -vorlagen nutzen oder anpassen. Wenn Sie ein neues Dokument basierend auf eines der folgenden Dokumentvorlagen anlegen, müssen Sie nur noch die Kontextelemente für die einzelnen Kapitel setzen. Anschließend lassen Sie die Dokumente generieren.

Wenn Sie ein neues Dokument anlegen und eine Vorlage wählen, die Kapitelvorlagen besitzt, wird das neue Dokument automatisch einschließlich aller Kapitel angelegt.

Kontextelemente

Über das Kontextelement bestimmen Sie, welche Elemente in das Dokument generiert werden sollen. In den meisten Fällen wählen Sie ein Package aus, das die Anforderungen, Stakeholder, Testfälle etc.enthält. Wenn Sie nicht zum gewünschten Package navigieren können, überprüfen Sie, ob das Package, das Sie zuweisen möchten, mit dem Package in der Vorlage übereinstimmt. Haben Sie die Kontextelemente einmal gesetzt, können Sie sie auch nachträglich ändern, ohne das Dokument neu anlegen zu müssen.

Anforderungsdefinition

In der nachfolgenden Tabelle finden Sie die Kontextelemente, die die einzelnen Kapiteln benötigen. Wenn Sie Kapitel nicht benötigen, löschen Sie sie oder passen Sie sie an.

Das komplette Kapitel „Anforderungsdefinition {Lösung}“ wurde in das Dokument als Kapitel hinzugefügt und ist somit kein Bestandteil des Dokuments. Das bedeutet, wenn Sie ein weiteres Dokument Anforderungsdefinition anlegen, müssen Sie das Kapitel „Anforderungsdefinition…“ als Referenz über den Befehl Dokument anlegen/ Kapitel hinzufügen in das Dokument hinzufügen.

KapitelKontextelementInhalt
Einleitung-Text
Anforderungsdefinition {Lösung}-Text
Systemfunktionen-Text
AnwendungsfällePackage vom Typ "UseCases"Anwendungsfälle, Anwendungsfalldiagramm
AkteurePackage vom Typ "UseCases"Akteure
ZielgruppenPackage vom Typ "Personas"Personas
Anforderungen-Text
Anforderungen an externe SchnittstellenPackage vom Typ "Requirements"Anforderungen vom Typ "InterfaceRequirement"
Funktionale AnforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "FunctionalRequirement", Anforderungsdiagramm
QualitätsanforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "QualityRequirement, PerformanceRequirement, UseabilityRequirement"
RandbedingungenPackage vom Typ "Requirements"Anforderungen vom Typ "Constraint"
Weitere AnforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "FunctionalRequirement, QualityRequirement, PerformanceRequirement, InterfaceRequirement, UseabilityRequirement, ConstraintlRequirement"
Wartungs- und Supportinformationen-Text
VerifikationPackage vom Typ "TestCases"Testfälle mit Anforderungen
Glossar-Glossar

Ziele und Kontext
In der nachfolgenden Tabelle finden Sie die Kontextelemente, die die einzelnen Kapiteln benötigen. Wenn Sie Kapitel nicht benötigen, löschen Sie sie oder passen Sie sie an.

KapitelKontextelementInhalt
Einleitung-Text
Stakeholder des SystemsPackage vom Typ "Stakeholders"Stakeholder mit Zielen und Anforderungen
Ziele des SystemsPackage vom Typ "Goals"Ziele, Abfrage Stakeholder mit Zielen
Ziele und ihre BeziehungenPackage vom Typ "Goals"Zieldiagramm
Abgrenzung des SystemsPackage vom Typ "SystemContext"Systemkontextelemente
SystemkontextdiagrammePackage vom Typ "SystemContext"Systemkontextdiagramm
Glossar-Glossar
Abbildungs/ Tabellenverzeichnis-Auflistung der Diagramme und Abfragen
Vision-Dokument
In der nachfolgenden Tabelle finden Sie die Kontextelemente, die die einzelnen Kapiteln benötigen. Wenn Sie Kapitel nicht benötigen, löschen Sie sie oder passen Sie sie an.

KapitelKontextelementInhalt
Einleitung-Text
StakeholderPackage vom Typ "Stakeholders"Stakeholder, Abfrage "Stakeholder mit Zielen kompakt"
ZielePackage vom Typ "Goals"Zieldiagramm, Ziele
Vision Statement-Text
Voraussetzungen/Rahmenbedingungen-Text
Produktmerkmale-Text
ArchitekturPackage vom Typ "Architecture"Blockdiagramm
Glossar-Glossar
Systemarchitektur
In der nachfolgenden Tabelle finden Sie die Kontextelemente, die die einzelnen Kapiteln benötigen. Wenn Sie Kapitel nicht benötigen, löschen Sie sie oder passen Sie sie an.

KapitelKontextelementInhalt
Einleitung-Text
Systembausteine des SystemsPackage vom Typ "Architecture"Blockdiagramm, Blöcke mit Ports, Schnittstellen
AnforderungsverfolgungPackage vom Typ "Requirements"Anforderungen
SchnittstellenübesichtPackage vom Typ "Architecture"Schnittstellen
Daten des SystemsPackage vom Typ "BusinessEntities"Klassendiagramm
Glossar-Glossar
Lastenheft
In der nachfolgenden Tabelle finden Sie die Kontextelemente, die die einzelnen Kapiteln benötigen. Wenn Sie Kapitel nicht benötigen, löschen Sie sie oder passen Sie sie an.

Das Lastenheft ist angelehnt am IEEE-Standard von 2011. Das Kapitel Anforderungen enthält mehrere Unterkapitel, die jeweils einen speziellen Anforderungstyp dokumentieren. Wenn Sie nur ein Kapitel für die Anforderungen verwenden möchten, passen Sie ein Kapitel an (die Filter in der Dokumentvorlage entfernen) und löschen Sie die anderen.

KapitelKontextelementInhalt
Einführung-Text
Zweck-Text
Stakeholder des SystemsPackage vom Typ "Stakeholders"Stakeholder
SystemumfangElement vom Typ "PlannedSystem"Geplantes System
Zielsetzung des SystemsPackage vom Typ "Goals"Ziele
Systemübersicht-Text
SystemarchitekturPackage vom Typ "Architecture"Blockdiagramm, Blöcke
SystemkontextPackage vom Typ "SystemContext"Systemkontextdiagramm, Systemkontextelemente, Akteure
SchnittstellenübersichtPackage vom Typ "Package"Schnittstellen
Blockübersicht mit PortsPackage vom Typ "Architecture"Blöcke mit Ports
Logisches DatenmodellPackage vom Typ "BusinessEntities"Klassen, Klassendiagramm
Einschränkungen-Text
Anforderungen an die Domäne-Text
Systemfunktionen-Text
AnwendungsfällePackage vom Typ "UseCases"Anwendungsfälle, Anwendungsfalldiagramm
AkteurePackage vom Typ "UseCases"Akteure
ZielgruppenPackage vom Typ "Personas"Personas
Anforderungen-Text
Anforderungen an externe SchnittstellenPackage vom Typ "Requirements"Anforderungen vom Typ "InterfaceRequirement"
Funktionale AnforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "FunctionalRequirement", Anforderungsdiagramm
QualitätsanforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "QualityRequirement, PerformanceRequirement, UseabilityRequirement"
RandbedingungenPackage vom Typ "Requirements"Anforderungen vom Typ "Constraint"
Weitere AnforderungenPackage vom Typ "Requirements"Anforderungen vom Typ "FunctionalRequirement, QualityRequirement, PerformanceRequirement, InterfaceRequirement, UseabilityRequirement, ConstraintlRequirement"
Wartungs- und Supportinformationen-Text
VerifikationPackage vom Typ "TestCases"Testfälle mit Anforderungen
ReferenzenPackage vom Typ "DirectoryProducts"Externe Dateien mit Anforderungen
Glossar-Glossar
Verzeichnisse-Text
Abbildungs/Tabellenverzeichnis-Auflistung der Diagramme und Abfragen

Inhaltsverzeichnis erstellen

Jedes Dokument benötigt ein Inhaltsverzeichnis. Das Inhaltsverzeichnis definieren Sie in der ersten Dokumentvorlage eines neues Dokuments – dem Deckblatt.  Das Inhaltsverzeichnis basiert auf die Überschriften, die Sie im Dokument definieren.

  1. Erstellen Sie eine neue Dokumentenvorlage für das Deckblatt und öffnen Sie diese in MS Word über den Kontextmenübefehl Bearbeiten.
    Die erste Seite ist Ihr Deckblatt, das Sie nach Belieben gestalten können. Auf der zweiten Seite fügen Sie das Inhaltsverzeichnis ein.
  2. Wechseln Sie in MS Word in die Registerkarte Verweise/Inhaltsverzeichnis.
  3. Klicken Sie auf ein Inhaltsverzeichnis, das automatisch generiert wird und fügen Sie es in das Dokument ein.
  1. Passen Sie die Formatvorlagen an und speichern Sie das Dokument.
    Die Formatvorlagen, die Sie hier definiert haben, werden automatisch an die nachfolgenden Kapitel weitervererbt, so dass Inhaltsverzeichnis und Kapitelüberschriften identisch sind.

Abbildungs-/Tabellenverzeichnis erstellen

Alle mitgelieferten Dokumente in objectiF RM beinhalten am Ende ein Abbildungs- und Tabellenverzeichnis. Das Abbildungsverzeichnis listet alle Diagramme, die im Dokument vorkommen, namentlich auf. Das Tabellenverzeichnis dagegen listet alle eingebetteten Abfragen namentlich auf. Wenn Sie die Auflistung der Diagramme und Abfragen nicht brauchen, löschen Sie die Kapitel aus der Dokumentvorlage.

Möchten Sie in einem neuen Dokument die Kapitel „Abbildungs- und/oder Tabellenverzeichnis“ haben, selektieren Sie die Dokumentvorlage und wählen im Kontextmenü den Befehl Dokumente anlegen/ Kapitelvorlage hinzufügen. Möchten Sie ein Dokument, um die beiden Kapitel erweitern, wählen Sie über das Kontextmenü den Befehl Dokumente anlegen/ Kapitel hinzufügen.

Abbildung/ Tabelle erstellen

Als erstes müssen Sie in der Dokumentvorlage definieren, was ein Verzeichnis ist.

  1. Erstellen Sie eine neue Dokumentvorlage oder öffnen Sie eine bestehende, die zukünftig ein Abbildungs- /Tabelleverzeichnis anzeigen soll.
  2. Öffnen Sie die Dokumentvorlage über den Kontextmenübefehl Bearbeiten.
    MS Word öffnet sich.
  3. Fügen Sie in die Vorlage ein Diagramm, eine Abfrage etc. ein.
  1. Wechseln Sie in MS Word in den Tab Verweise/ Beschriftungen einfügen.
  2. Wählen Sie über das Dropdown-Menü hinter Bezeichnung eine Beschriftung aus. Sie können über Neue Bezeichnung eine eigene erstellen.
  1. Fügen Sie sie über OK in das Dokument ein.
  1. Fügen Sie sie über OK in das Dokument ein.
    Beschriften Sie Diagramme mit dem Platzhalter Name, damit später der Name des Diagramms im Abbildungsverzeichnis generiert werden kann. Bei Abfragen können Sie den Namen der Abfrage direkt angeben, da die Tabelle sich nicht ändern wird, sondern nur der Inhalt.
  2. Wechseln Sie unter Textmarken auf die Registerkarte Eigenschaft, wählen Name und klicken anschließend auf Einfügen.
  3. Bevor Sie das Dokument speichern, formatieren Sie noch die Beschriftung.

Kapitel „Abbildungs-/Tabellenverzeichnis“ erstellen

  1. Erstellen oder öffnen Sie eine Dokumentvorlage die später die Verzeichnisse ausgeben soll.
  2. In MS Word wechseln Sie in den Tab Verweise und klicken auf Abbildungsverzeichnis einfügen.
  3. Im Folgedialog können Sie die Darstellung anpassen und je nachdem, ob ein Abbildungs- oder ein Tabellenverzeichnis erstellt werden soll unter Allgemein/Beschriftungskategorie das entsprechende auswählen.

Glossar

Jedes mitgelieferte Dokument besitzt ein Kapitel, das sämtliche Glossareinträge in das Dokument generiert. Für neue Dokumente, verwenden Sie die Dokumentvorlage Glossar, welches Sie im Fenster Einstellungen unter Einstellungen / Dokumentvorlagen/ Kapitel finden.

  • Öffnen Sie eine Dokumentvorlage und wechseln unter Textmarken in die Registerkarte Glossar.
  • Klicken Sie auf Einfügen und speichern Sie die Vorlage.