Benutzerhandbuch:Hilfe

This Wiki is read-only for reference purposes to avoid broken links.

Einführung

Diese Seite soll als Hilfe für diejenigen dienen, die sich an der Dokumentation beteiligen möchten und wissen möchten, welche Format- und Textelemente zu Verfügung stehen.

Infos zu generellen Bearbeitung von Wiki-Seiten findet ihr hier: [1]

Schreibphilosophie

Wer kennt das nicht? Die Dokumentation einer Software besteht nur aus Beschreibungen von Elementen, die sich sowieso selbst erklären. Was sich dann etwa so liest: Feld "Name" enthält den Namen des Kunden. Informationen darüber wie die Software zu benutzen ist und wie die Zusammenhänge sind, findet man hingegen nur schwerlich.

Genau das soll bei diesem Benutzerhandbuch anders sein. Am Anfang steht das Problem eines Benutzer wie z.B. "Ich möchte ein Angebot erstellen". Der Inhalt dieser Dokumentation soll darauf schlüssig Antwort geben (Beispiel Benutzerhandbuch:Angebot erstellen).

Dabei ist zu beachten, dass die Antwort nicht etwa in allen Variationen und Wenn-Fällen erfolgt, sondern der Fall stringent beschrieben wird, ohne sämtliche Ausnahmen zu beschreiben. Dadurch ist es möglich einen einfachen Vorgang in kurzen knackigen Punkten und in einer für den Leser leicht nachzuvollziehenden Reihenfolge zu beschreiben.

Arbeitsgrundlage

• Geplant:
  • Deutsche AVA mit ADempiere Version 3.4 (in Entwicklung)
  • Deutsche Sprachlokalisierung (in Arbeit)

• In der Übergangszeit:
  • AVA 331b (Link zu SF)
  • Vorschlag für Deutsches Language Pack (400KB zip)

Elemente

Überschriften

Überschriften sind bereits durch das Inhaltsverzeichnis vorgegeben.

Formatierung von Formularfeldern

Bezeichnungen von Feldern in Masken wie z.B. "Kundenname" werden in fett dargestellt.

Um einen Text als fett zu markieren, die entsprechende Stelle mit ''' einrahmen.

Beispiel: '''Kundenname''' wird zu Kundenname

Schreibweise von Tabulatoren

Tabulatoren werden mit aus der Kombination "Tab" + <Bezeichnung des Tabulators in Anführungszeichen> angegeben.

Beispiel: Im Fenster "Auftrag" würde der Tabulator "Auftragszeile" wie folgt angegeben:

Tab "Auftragszeile" auswählen

Textbox

Diese Box kann dazu verwendet werden dem Leser zusätzliche Tips oder Infos zu geben, die besonders hervorzuheben sind.

Um einen Text mit einer Box zu umranden, die entsprechende Zeile mit einem Leerzeichen beginnen.

Beispiel

Aufzählungen (ohne Reihenfolge)

Aufzählungen, bei der die Reihenfolge unwichtig ist, können mit einem * am Anfang der Zeile dargestellt werden.

Beispiel:

• B1
• B2
  • B3

Aufzählungen (mit Numerierung)

Aufzählungen, bei denen die Reihenfolge angezeigt werden soll, können mit einem # am Anfang der Zeile dargestellt werden.

Beispiel:

1. B1
2. B2
   1. B3

Symbole / Icons

Verfügbare Symbole wie z.B. sind auf einer separaten Seite zu finden.

Tips

• Um bei der Vielzahl an Seiten nicht durcheinander zu kommen, könnt ihr den Kategorie-Link "Category:Benutzerhandbuch" am Ende einer jeden Seite verwenden um auf die Übersichtsseite zu gelangen.