Styleguide: Artikel, die Prozesse beschreiben
Innerhalb der Hilfe gibt es Artikel, die einzelne Arbeitsabläufe(=Prozesse) beschreiben.
Innerhalb der Prozessartikel ist es sinnvoll Oberflächenabbildungen im Text zu verwenden. Dabei sollten aber – im Unterschied zu den Artikeln aus dem Bereich Beschreibung der Oberfläche – nur der für die aktuell beschriebene Aktion notwendige Teil abgebildet werden, ggf. ist mit Hilfe eines Grafikbearbeitungsprogramms (z.B. MS Paint) ein entsprechender Ausschnitt aus einem Screenshot zu machen. Ggf. sollte auch das entsprechende Element durch eine (rote) Markierung in der Abbildung hervorgehoben werden.
Prozessartikel beginnen mit einer Table of Contents:
__TOC__
Danach kommt ein Bereich in dem die notwendigen Voraussetzungen beschrieben sind, um mit dem Prozess beginnen zu können:
=Voraussetzungen=
Was muss eingerichtet sein? [[Link zur Einrichtungsseite]]
Welche Daten müssen gefüllt sein? [[Link zur Beschreibung der Dateneingabe]]
Anschließend kommt die eigentliche Beschreibung des Ablaufs:
=Durchführung=
# Machen Sie zuerst Dieses
# Dann machen Sie Jenes
## Jenes erster Schritt
## Jenes zweiter Schritt
# Anschließend passiert Folgendes
In einem weiteren Kapitel werden die Rückmeldungen von Mauve System3 beschrieben
=Auswertung der Rückmeldungen=
Abschließend werden Hinweise zur Fehlerbehandlung gegeben
=Fehlerbehandlung=
Am Ende wird eine Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben) eingefügt.
- Siehe auch