Konfigurationen/Objekte
[Beschreibender Text:
Fließtext zur Funktionalität des Programms in max. 5-6 Sätzen.
Inhalt: Hauptfunktionalität des Programms? Aufbau des Programms? Was kann Nutzer damit machen? Mögliche Verzweigungen/Zusammenhänge zu anderen Programmen?
Bsp: „Im Programm ‚Geschäftspartner‘ verwalten Sie alle wichtigen Stammdaten rund um Ihre Geschäftspartner. Das Programm ist als Zusammenstellung von verschiedenen Informationsbereichen aufgebaut und bietet damit eine Übersicht über Daten aus den verzweigten Programmen (z.B. Kundenstamm verwalten, etc.)…“ ]
Weitere Themen:
[Laschenbeschreibung:
Fließtext max. 5-6 Sätze, übergreifende Informationen zu Daten in Datenlasche, keine einzelnen Datenfelder;
Datenlaschen mit Eingabefeldern: "Hier bearbeiten Sie die Daten für/zu..."
Datenlaschen mit vorbelegten Datenfeldern: "Hier werden die Daten zu... angezeigt." Hier zusätzliche Angabe des Bereichs,aus dem Daten stammen "Die angezeigten Daten werden im Programm xy gepflegt."
Bsp: "Hier bearbeiten Sie Informationen zu Fracht, Rechnungsstellung und Zahlungsbedingungen. Der Inhalt dieser Felder wirkt sich von der Auftragseinschreibung bis zur Rechnungsschreibung bzw. der Übergabe der offenen Posten an die Finanzbuchhaltung aus."]
[Beschreibung Zusatzthema:
Fließtext in max. 3-5 Sätzen; Thema, das Bearbeitung des Programms betrifft, aber über allgemeine Beschreibung hinausgeht;
Beschreibung der Funktion, um was geht es? Was kann der Nutzer damit machen? Worin liegt die Bedeutung für das Programm?
"Der/die/das ist ein..., dass/mit dem..."
Bsp: "Die Änderungshistorie ist ein System, mit dem Sie bestimmte Bearbeitungsvorgänge in den Geschäftspartnerdaten festhalten…"]
So gehts:
- [Schritt 1: Verb-Erststellung + direktes Ansprechen des Nutzers + Gegenstand der Handlung; Effekt der Handlung vor Ausführungsschritt
Bsp: "Klicken Sie mit der rechten Maustaste auf die Datenkategorie.", "Speichern Sie die Eingabe, indem Sie die Enter Taste drücken."] - [Schritt 2]
- [Schritt 3]
- [Schritt 4]
- [Schritt 5]
- [Schritt 6]
- [Schritt 7]
→ [Resultat: Ergebnis der Handlung; Wiederaufnahme des Anleitungstitels + eventuelle Folgeeffekte
Bsp: "Die Adressmerkmale wurden zum Ansprechpartner hinzugefügt und werden unter der Datenkategorie Ansprechpartner aufgelistet." ]
So gehts:
- [Schritt 1]
- [Schritt 2]
- [Schritt 3]
- [Schritt 4]
- [Schritt 5]
- [Schritt 6]
- [Schritt 7]
→ [Resultat: Ergebnis der Handlung; Wiederaufnahme des Anleitungstitels + eventuelle Folgeeffekte
Bsp: "Die Adressmerkmale wurden zum Ansprechpartner hinzugefügt und werden unter der Datenkategorie Ansprechpartner aufgelistet." ]
So gehts:
- [Schritt 1]
- [Schritt 2]
- [Schritt 3]
- [Schritt 4]
- [Schritt 5]
- [Schritt 6]
- [Schritt 7]
→ [Resultat: Ergebnis der Handlung; Wiederaufnahme des Anleitungstitels + eventuelle Folgeeffekte
Bsp: "Die Adressmerkmale wurden zum Ansprechpartner hinzugefügt und werden unter der Datenkategorie Ansprechpartner aufgelistet." ]
[Definition zu Begriff 1:
Fließtext max 1-2 kurze Sätze; Erläuterung der allgemeinen Bedeutung
"Als...wird/werden (in oxaion)...bezeichnet..."
Bsp: "Als Datenlaschen werden in oxaion die Laschen bezeichnet, in denen die Datenfelder eines Bearbeitungsfensters angelegt sind."]
[Definition zu Begriff]
[Definition zu Begriff]
[Definition zu Begriff]
[Definition zu Begriff]
Tabellen
- [vorkommende Tabelle 1:
Tabellenbezeichnung, Tabellennummer, Tabellenname + Funktion im Kontext des Programms; 1:1 wie in oxaion angegeben
Bsp: "FRD 105 'Verhalten bei gleichen Adressen': Steuert das Verhalten des Programms bei nicht eindeutigem Matchcode."] - [vorkommende Tabelle 2]
- [vorkommende Tabelle 3]
Programme
- [vorkommendes Programm 1:
Vorkommendes Programm: Programmnummer + Programmname + Funktion des Programms im Kontext des (in der Hilfe erläuterten) Programms] - [vorkommendes Programm 2]
- [vorkommendes Programm 3]
- [Handbuch 1: Bezeichnung des Handbuchs 1:1, dessen Themen für das Programm relevant sind]
- [Handbuch 2]
- [Handbuch 3]
- Ursache: [Ursache 1 Text:
Gegenstand der Ursache + konjugiertes Verb + Beschreibung der Ursache
Bsp: "Der Datensatz existiert mit den gewählten Angaben bereits unter der ausgewählten Adressnummer und kann für eine Hauptadresse nur einmal angelegt werden."] - [Maßnahme 1 Text:
Aufforderung in Form einer Handlungsanweisung, die zur Behebung des Problems führt;
Verb Erststellung + direkte Anrede des Nutzers + Gegenstand der Handlung
Bsp: "Löschen Sie gegebenenfalls den alten Datensatz, falls Sie ihn nicht mehr brauchen."] - [Maßnahme 2 Text]
- Ursache: [Ursache 2 Text]
- [Maßnahme 1 Text]
- [Maßnahme 2 Text]
Maßnahme:
Maßnahme:
- Ursache: [Ursache 1 Text]
- [Maßnahme 1 Text]
- [Maßnahme 2 Text]
- Ursache: [Ursache 2 Text]
- [Maßnahme 1 Text]
- [Maßnahme 2 Text]
Maßnahme:
Maßnahme:
- Ursache: [Ursache 1 Text]
- [Maßnahme 1 Text]
- [Maßnahme 2 Text]
- Ursache: [Ursache 2 Text]
- [Maßnahme 1 Text]
- [Maßnahme 2 Text]
Maßnahme:
Maßnahme:
Hinweis
Bsp: "Beim Löschen einer Hauptadresse werden auch alle zugehörigen Datenkategorien mitgelöscht!"]
Voraussetzung:
[optional, nur falls benötigt; Fließtext max. 1-2 Sätze, Beschreibung der Voraussetzung, die vorliegen muss, um eine Handlung erfolgreich ausführen zu können; steht vor der auszuführenden Handlung oder nach kurzem Fließtext]
"Um...zu" + Voraussetzung
Bsp: "Um ein CPD Konto anlegen zu können, muss im Personenkonto (in der Lasche „Stamminformationen“) am Datenfeld „Kennzeichen für CPD Konto“ der Haken gesetzt sein."]