struktur
Table of Contents
Hinweise zur Erstellung/ Bearbeitung einer Seite
<note important>Auf den deutschen Seiten gibt es keine Incidents nur Anfragen!</note>
<note important>Englische Seite ebenfalls erstellen!
Besondere Beachtung der Bilder und Links!</note>
<note important>Versionshinweise überall wo möglich und nötig ist angeben. Aber nur 3 Stellen: Bsp.: Version 5.2.1</note>
Aufbau der Seite
- Der Aufbau der Seite ergibt sich aus
- der Reihenfolge aus 1stAnswer
Bsp.: siehe Startseite -> Incident Management: Anfrage bearbeiten - dem Workflow (logischer Ablauf)
Bsp.: Anfrage erstellen → speichern → CI hinzufügen → Speichern und zurück in den Pool
- Redundanz vermeiden. Punkte die bereits an anderer Stelle beschrieben sind nicht noch einmal erklären, sondern darauf verweisen. (klappt bisher schon ganz gut
)
Ansprache des Lesers
- Der Leser wird mit “Sie” direkt angesprochen und nicht mit “der Benutzer” oder “man”.
Text
- Überschriften sind sinngemäß (das der Leser weiß, was sich dahinter verbirgt) zu vergeben.
- Worte/ Begriffe, die aus 1stAnswer stammen werden mit
<html><font color="darkorange"><b>...</b></font></html>
hervorgehoben. (Für den Wiedererkennungswert im System)
Bsp.: Klicken Sie im<font color="darkorange"><b>Ich möchte</b></font>-Panel bitte auf<font color="darkorange"><b>Cockpit hinzufügen</b></font>. - Damit die Leser sich im Text schneller zurecht finden werden einzelne Worte FETT hervorgehoben.
Bsp.: Über dieses Symbol können Sie die Notiz löschen.
- Tabellen:
- Am Ende eines Textes, wenn nicht anders gedacht, 2 Leerzeichen machen, damit der Text linksbündig ist.
Bsp. Tabelle:
^Titel^ |linksbündig | | zentriert |
| Titel |
|---|
| linksbündig |
| zentriert |
Bilder
- Jedes Bild bekommt einen aussagekräftigen Titel mit dem ein Leser das Bild der Dokumentation richtig zuordnen kann. (Meist Hilft euch 1stAnswer bereits dabei )
Bsp.:
- Markierungen auf Bildern (Einstellungen in Paint.NET):
- Umrandungen:
- Fenster: Tools → Rechteck
- Farbe: Orange
- Stärke: 4
- Pfeile:
- Fenster: Tools → Linie/ Kurve → Linienanfang: ausgefüllter Pfeil
- Farbe: Orange
- Stärke: 3
- Text:
- Fenster: Tools → Text
- Farbe: Orange
- Schriftart: Arial
- Schriftgröße: 16
- Fett
- Werden Bilder ersetzt, bitte die ersetzten Bilder, sofern möglich, aus DokuWiki löschen, um die Menge an Bildern auf die verwendeten zu beschränken.
struktur.txt · Last modified: 2011/03/04 09:23 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
