Abschnitte der Dokumentation als Vorlage definieren

Beschreibung

Definiere Abschnitte in einer Dokumentation als Vorlagen, damit diese für neue Abschnitte einfach angewendet werden können.

Details

Auf Work Items kannst du eine Dokumentation schreiben, indem du im Dokumentations-Tab Abschnitte erstellst (siehe Abschnitte erstellen).

Da bestimmte Dokumentationsabschnitte nach dem selben Muster immer wieder Verwendung finden, kannst du Abschnitte in den Einstellungen des eigenen Work Item-Typs im Dokumentations-Tab definieren. Diese werden beim Erstellen eines Work Items dieses Typs automatisch generiert und in die Dokumentation eingefügt. Zudem kannst du einzelne Abschnitte als Vorlage definieren, damit diese beim Erstellen von neuen Abschnitten ausgewählt werden

Schritt-für-Schritt-Anleitung

Um vordefinierte Abschnitte und Vorlagen in der Dokumentation zu verwenden, erstellst du zuerst einen Abschnitt auf der Definition des Work Item Typs. Dieser wird dann als Standard für jede Dokumentation eines Work Items dieses Typs automatisch erstellt. Zusätzlich kannst du einzelne Abschnitte als "Vorlage" markieren, damit sie immer wieder genau nach dem vordefinierten Muster zur Verfügung stehen.

Vordefinierte Abschnitte

1. Erstelle einen neuen Arbeitselement-Typen (siehe Eigene Work Item-Typen definieren)
   
2. Klicke in der Arbeitselement-Typ Definition  auf den Dokumentations-Tab.
   
   
   Abb. 1: Auf Dokumentation im Arbeitselement-Typ wechseln
   
   
3. Klicke auf "Abschnitt hinzufügen" und gib den Namen des Abschnitts ein.
   Abb. 2: Namen des Abschnitts eingeben
   
   
4. Bearbeite nun deinen Abschnitt so, wie du sie später im Work Item verwenden möchtest.
   
   
   
   Abb. 3: Inhalt des Abschnitts erstellen
   
   
5. Erstelle ein Work Item mit dem entsprechenden Work Item-Typ und klicke auf den Dokumentations-Tab im Work Item.
   
6. Der vordefinierte Abschnitt wurde automatisch eingefügt und es kann unmittelbar mit dem Dokumentieren gestartet werden.
   
   Abb. 4: Automatisch eingefügter Abschnitt in der Work Item Dokumentation
   

Vordefinierter Abschnitt als Vorlage erstellen

Möchtest du, dass der vordefinierte Abschnitt als Vorlage in der Dokumentation dieses Work Item Typs zur Verfügung steht, kannst du den Abschnitt einfach als Vorlage markieren.

1. Erledige die Schritte 1. bis 4. wie oben beschrieben.
2. Klicke auf dem eben erstellten Abschnitt auf die drei Punkte und dann auf Vorlage.
   
   
   
   Abb. 5: Abschnitt als Vorlage markieren
   
3. Um diese Vorlage zu verwenden, kannst du ein Work Item vom entsprechenden Typ erstellen und auf der Dokumentation auf "Abschnitt hinzufügen". Gib den gewünschten Namen deines Abschnittes ein und wähle die Vorlage im Drop-Down aus. Wenn du eine nicht-leere Vorlage auswählst, kannst du den Namen nicht setzen, weil er von der Vorlage vorgegeben ist.
   
   
   Abb. 6: Abschnitte aus Vorlagen hinzufügen
   
   
4. Wenn du auf OK klickst, ist die definierte Vorlage sogleich in der Dokumentation.

Verweise

Abschnitte erstellen

Reihenfolge ändern