Archiv für die Kategorie „Benutzerdokumentation“
Kassensysteme als Dokumentationsprojekte
Dokumentation Kassensystem - Strukturierende Orientierungshilfen in der Benutzer
Unter dem Oberbegriff strukturierende Orientierungshilfen sind alle Orientierungshilfen zusammengefasst, die sich auf die Struktur der Benutzerdokumentation eines Kassensystems auswirken. Strukturierende Orientierungshilfen helfen Leser und Autor durch die Struktur der Dokumentation wie beispielsweise die Dezimalklassifikation, oder sie geben eine Struktur vor wie z.B. ein Überblickskapitel oder die verschiedenen Verzeichnisarten. Im folgenden sind strukturierende Orientierungshilfen ohne Anspruch auf Vollständigkeit beschrieben.
Titelseite
Die Titelseite der Benutzerdokumentation eines Kassensystem s ist als erste Seite die Kontaktseite zum Leser. Sie ist ein notwendiger Bestandteil jeder eigenständigen Dokumentation und dient der eindeutigen, übersichtlichen und schnellen Identifikation von Gegenstand, Dokument, Dokumenttyp und Dokumentzweck bereits von außen. Die Titelseite der Benutzerdokumentation eines Kassensystems sollte folgende Elemente enthalten:
-
Dokumenttyp, z.B. ,,Bedienungsanleitung”, ,,Benutzerhandbuch”, ,,Wartungshandbuch”
-
Hersteller des Beschreibungsgegenstands
-
Genaue Bezeichnung des Beschreibungsgegenstands, z.B. “Mikrowelle”, “Programmiersprache”
-
Typenbezeichnung, z.B. ,,HP Inkjet 550″ oder ,,Visual Basic V5.0″. Im Maschinen- und - Anlagenbau, also auch für ein Kassensystem, kann die Verpflichtung zur eindeutigen Identifizierung so weit gehen, dass zusätzlich zur Typenbezeichnung die Seriennummer der Maschine auf der Titelseite der Dokumentation genannt werden muss.
- Abbildung des Beschreibungsgegenstands oder z.B. bei Software ein Signet oder eine Grafik, die den Beschreibungsgegenstand symbolisiert.
Weiterhin können auf der Titelseite eventuell wichtige Sonderfunktionen, wie z.B. ,,Dieselausführung” oder ,,für Windows NT”, oder das Druckdatum und die Versionsnummer angegeben werden.
Dezimalklassifikation
Die Dezimalklassifikation gliedert die Dokumentation der Kassensysteme nach dem Dezimalsystem. Im Gegensatz dazu gibt es auch eine alphanumerische Gliederung, die vor allem in wissenschaftlichen Publikationen verwendet wird, in der Regel in der Technischen Dokumentation eines Kassensystems aber keine Verwendung findet. Die Dezimalklassifikation wird in einigen Vorschriften für Technischen Dokumentation empfohlen (z. B. DIN 8414 mit Verweis auf DIN 1421, DIN 1422 Teil 1 und DIN 58 122). Der Technische Redakteur ist jedoch nicht verpflichtet, sein Dokument mit einer Dezimalklassifikation zu versehen. Die Dezimalklassifikation ist in keinem Fall ein Ersatz für eine gute Gliederung. Sie kann in einer umfangreichen Benutzerdokumentation eines Kassensystems deren Gliederung aber unterstützen, indem sie aufeinander folgende Informationen optisch zusammenfasst und so Handlungsabläufe deutlicher macht.
Beispiel:
1. Inbetriebnahme der Kassensysteme
1.1 Gerät aufstellen
1.2 Gerät anschließen
1.3 Gerät einschalten
1.4 Artikel einstellen
1.4. 1 Artikel manuell einstellen
1.4.2 Artikel per Computer einstellen
2. Reinigung und Pflege des Kassensystems
Je tiefer allerdings die Hierarchie der Gliederung, desto weniger deutlich wird sie auch durch die Dezimalklassifikation. Mehr als drei oder vier Gliederungsstufen sind nicht zu empfehlen. Bei kleineren Dokumenten ist eine Dezimalklassifikation nicht sinnvoll.