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 Information | 3.3 |
---|---|
Zielgruppe | Fachspezialisten für Leistungsabrechnungen bei Versicherern und Apotheken |
Zusammenfassung | Dieses Benutzerhandbuch beschreibt den Inhalt und die Bedienung der Web-Applikation. Die Web-Applikation ermöglicht einen effizienten Zugang zu den Informationen. |
Die Dokumentation werden, wenn immer möglich, als One-Page-HTML Seiten aufbereitet und strukturiert.
Verwendung von Headings nach Standard-Paragraphen ohne Überschriftsnummern.
Code blocks werden mit dem Macro 'Code Block' dargestellt. Das Syntax Highlighting muss dem Inhalt entsprechend gewählt werden. Settings: collaps = true, linenumbers = true.
Folgende Info-Blöcke sollen für die beschriebenen Zwecke verwendet werden:
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. |
Referenzen auf Attachments und andere Ressourcen können global im Panel rechts oben aufgelistet werden, aber auch eingebunden im Text:
<div class="references"> |
</div> |
Tabellen sollen mit einer horizontaler oder vertikaler Header-Zeile erfasst werden:
Header 1 | Header 2 |
---|---|
Cell 1A | Cell 2A |
Cell 1B | Cell 2B |
Header 1 | Cell 1A | Cell 1B |
---|---|---|
Header 2 | Cell 2A | Cell 2B |
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 |
</div> |
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.