Dokumentation in Kapitel und Abschnitte gliedern

Beschreibung

Gliedere deine Dokumentation in Kapitel und Abschnitte und dokumentiere mit Texten, Grafiken, Tabellen und vielem mehr.

Details

Work Items (also auch Aufgaben) können dokumentiert werden, indem du eine Dokumentation erstellst und dort wichtige Informationen festhältst. Diese steht unter dem Tab «Dokumentation» zur Verfügung.

Eine Dokumentation wird durch Überschriften in Kapitel gegliedert. Jedes Kapitel besteht aus einem oder mehreren Abschnitten, die aus Texten, Tabellen, Bildern und mehr bestehen können. Diese können nach dem Erstellen überarbeitet werden und es ist teilweise auch bei der Überarbeitung möglich, den Typ zu wechseln - zum Beispiel von "Text" zu "Überschrift".

Schritt-für-Schritt-Anleitung

1. Öffne das Work Item (z.B. die Aufgabe «Kundendokumentation vorbereiten»), wo du eine Dokumentation erstellen möchtest und wechsle auf das Tab «Dokumentation» (siehe Abb. 1).
   
   
   Abb. 1 - Dokumentation eines Work Items öffnen
    
   
2. Klicke direkt in den Dokumentationsbereich rechts, um einen ersten Block hinzuzufügen (siehe Abb. 2).
   Der standardmässige Block ist ein Text.
   
   
   
   Abb. 2 - Ersten Block hinzufügen
    
   
3. Wenn du einen Abschnitt erstellen möchtest, kannst du als ersten Block eine Überschrift auswählen (siehe Abb. 3). Alle Blöcke, die nach dieser Überschrift kommen, sind dem Abschnitt untergeordnet.
   
   Abb. 3 - Überschrift hinzufügen
   
   Sobald du eine Überschrift auf der gleichen Stufe erstellst, z.B. Überschrift 1, beginnt ein neuer Abschnitt (siehe Abb. 4).
   
   
   Abb. 4 - Dokumentation mit zwei Abschnitten
    

Verweise

Block bearbeiten

Unterabschnitt hinzufügen