Mauve System3 Handbuch:Über Mauve System3 Handbuch
Aus Mauve System3 Handbuch
Inhaltsverzeichnis |
Styleguide für Handbucheinträge
Allgemeines
Für die Dokumentation wird eine allgemeingültige Struktur festgelegt, nach der alle Funktionen/Module des Mauve System3 beschrieben werden.
Möglichkeiten:
- Nach Anwendungsfällen (Konfiguration, Adressverwaltung, Artikelverwaltung, Auftragsabwicklung, FiBu)
- Nach Funktionen (Kernfunktionalität, Module)
- Prozessorientiert
Beiträge
- Beiträge werden nach dem Modulnamen benannt. Für mögliche Namensderivate werden Weiterleitungen angelegt.
Artikelname: Artikel (F11) Weiterleitung: #redirect [[Artikel (F11)]]
- Es wird überall die gleiche Gliederung genutzt (Siehe: Beispiel Handbuch Eintrag)
- Der Names der Software wird immer in fett und vollständig ausgeschrieben Mauve System3 ('''Mauve System3''')
- Der Names des Webshops wird immer in fett und auseinader ausgeschrieben Mauve Webshop System ('''Mauve Webshop System''')
- Verweise auf andere Beiträge sind grundsätzlich zu verlinken. [[Artikel (F11)] verlinkt auf [[Artikel (F11)].
- Beschreibungen für Menüpfade müssen mit '/' als Trenner angegeben werden: "Shop Verwaltung / Preissuchmaschinen / Yatego"
- Labels in Dialogen und Formularen werden fett formatiert
- Weiterführende Links am Ende eines Artikels werden immer so dargestellt:
- Siehe auch: Adressen (F7)
oder (bei mehreren Links)...
- Siehe auch:
Dialoge
Dialoge müssen grundsätzlich nicht nur beschrieben werden, sondern auch als Screenshot eingebunden werden.
Gehört ein Bild nur zu einem bestimmten Abschnitt, muss am Ende des Abschnittes <br style="clear:both" /> eingebunden werden, damit das Bild nicht in den nächsten rutscht.
Beiträge, die nur den Dialog beschreiben, müssen das Bild vollständig anzeigen. Der Text beginnt unterhalb des Bildes. Dazu muss <br style="clear:both" /> eingebunden werden. Der Dialog muß ausführlich die Funktionen und Zusammenhänge des Dialoges und die Auswirkungen auf das System erklären.
Bilder von Dialogen in Modulbeschreibungen und Übersichten als rechtsbündiges Thumbnail mit Namen: [[Bild:Foobar.png|thumb|right|Foobar]].
Bilder
- Bilder werden grundsätzlich als PNG abgelegt.
- Leerzeichen werden entfernt.
- Keine sonstigen Trenner verwenden.
- Screenshot nur mit ALT + DRUCK machen (Screenshot vom aktuellen Fenster).
- Screenshots werden unter Windows Vista gemacht, um ein einheitliches Gesamtbild zu gewährleisten.
Mediawiki Software
Hilfe zur Benutzung und Konfiguration der Wiki Software finden Sie im Benutzerhandbuch.
