Titel ohne Applikationsname (Ausnahme: Bei Erwähnung in Komponentenname. Z.B. ZSR-Web)

Titel ohne Version bei fortlaufenden Dokumentationen (Ausnahme: Parallele Versionen der gleichen Komponentendokumentation wird publiziert).

Release InformationLink auf Release-Notes
ZielgruppeAnwender, Entwickler, Integratoren, Betreiber
ZusammenfassungKurze Zusammenfassung des Inhalts




Die Dokumentation werden, wenn immer möglich, als One-Page-HTML Seiten aufbereitet und strukturiert.

Darstellungen

Überschriften

Verwendung von Headings nach Standard-Paragraphen ohne Überschriftsnummern.

Sourcen

Code blocks werden mit dem Macro 'Code Block' dargestellt. Das Syntax Highlighting muss dem Inhalt entsprechend gewählt werden. Settings: collaps = true, linenumbers = true.

// C# program to print Hello World! 
using System; 
  
// namespace declaration 
namespace HelloWorldApp { 
      
    // Class declaration 
    class Geeks { 
          
        // Main Method 
        static void Main(string[] args) { 
              
            // statement 
            // printing Hello World! 
            Console.WriteLine("Hello World!"); 
              
            // To prevents the screen from  
            // running and closing quickly 
            Console.ReadKey(); 
        } 
    } 
} 

Info-Blöcke

Folgende Info-Blöcke sollen für die beschriebenen Zwecke verwendet werden:

Info-Text für Informationen, welche hervorgehoben werden müssen.


Weiterführende Informationen zu einem Thema werden in einer Notizbox erfasst. 


Muss der Leser auf eine bestimmte Gegebenheit besonders achten, so soll dies in einer Warnung dargestellt werden.

Links

Referenzen auf Attachments und andere Ressourcen können global im Panel rechts oben aufgelistet werden, aber auch eingebunden im Text:

<div class="references">

http://www.google.com

</div>

Tabellen

Tabellen sollen mit einer horizontaler oder vertikaler Header-Zeile erfasst werden:

Header 1Header 2
Cell 1ACell 2A
Cell 1BCell 2B
 


Header 1Cell 1ACell 1B
Header 2Cell 2ACell 2B
 

Diagramme

Diagramme werden direkt als draw.io Inhalte im Confluence erfasst.


<div class="references">


Globale Referenzen für diese Dokumentationsseite: 

- Links auf Attachments der Seite, Display Text des Links entspricht normalerweise unverändert dem Namen des Attachments. Normalerweise soll die Confluence-Versionierung für Attachments verwendet werden (Ausnahme: Publikation von parallelen Versionen).

- Links auf externe Seiten

- Links auf andere Confluence-Einträge

SASIS (public)


</div>


Bilder

Bilder werden normalerweise mit einer maximalen Breite von 400px dargestellt (situative Ausnahmen erlaubt). Grössere Bilder können mittels Click vergrössert werden.

Falls Text zum Bild vorhanden ist, so soll dieser nach Möglichkeit mit Hilfe von Sections neben dem Bild dargestellt werden.

Bildeinstellungen: Effects: None; Border: None

Im Text referenzierte UI-Elemente (Menüpunkte, Buttons, Links, etc.) werden mittels fetter, kursiver Schrift dargestellt (ohne Anführungszeichen etc.).

Bei Beschreibungen von umfangreichen UI's und Abläufen kann das UI mit Nummern versehen werden. Die bearbeitbare Quelldatei muss ebenfalls als Attachment dem Beitrag hinzugefügt werden, damit diese zu einem späteren Zeitpunkt auch angepasst werden kann.