Registrierkasse – Wesentliches zur Dokumentation

Registrierkasse - Gliederung einer Benutzerdokumentation

Mit der Handbuchgliederung wird im Großen festgelegt, welche Teile neben dem sachlichen Inhalt zu einem Benutzerhandbuch für Systeme gehören und in welcher Reihenfolge diese Teile angeordnet werden. Im wesentlichen ist damit eine Reihe von Verzeichnissen angesprochen.

Das Inhaltsverzeichnis stellt die Gliederung des gesamten Registrierkassen Handbuches, insbesondere dem sachlichen Inhalt, dar, indem es die Überschriften der einzelnen Kapitel und Abschnitte mit der jeweiligen Seitennummer des Beginns auflistet. Die Hauptüberschriften sollten dabei auch optisch deutlich hervorgehoben werden. Wird bei einer umfangreichen Dokumentationen mit starker Unterteilung , wie einem Benutzerhandbuch für Systeme, das Inhaltsverzeichnis leicht unübersichtlich und lang, werden nur die Hauptkapitel und deren direkte Unterabschnitte aufgenommen. Dafür wird dann jedem Kapitel ein eigenes detaillierteres Inhaltsverzeichnis vorangestellt.

Ein Abkürzungsverzeichnis sollte die Abkürzungen, die im Text eines Benutzerhandbuches für Systeme verwendet werden, zusammenfassen und erläutern. Abkürzungsverzeichnisse werden alphabetisch sortiert. Im Literaturverzeichnis werden Quellen für die Erstellung des Handbuchtextes eines Systems und Hinweise auf ergänzende Unterlagen angegeben. Bei der Angabe der Quellen sind nur allgemein zugängliche Unterlagen anzugeben. Unternehmens interne Dokumente wie Pflichtenhefte sind dem Leser nicht zugänglich und nützen in einem Literaturverzeichnis nichts. Ein Glossar enthält zusammengefasst wichtige Begriffsdefinitionen, die für das Verständnis des Textes nötig sind. Ein Glossar eines Benutzerhandbuches für eine Registrierkasse sollte alphabetisch sortiert und nach Art eines Lexikon aufgebaut sein.

Das Stichwortverzeichnis listet die wichtigsten Begriffe und die Stellen auf, an denen diese Begriffe im Text vorkommen. Es ist ein wichtiges Hilfsmittel für den Zugriff auf Informationen. Das Stichwortverzeichnis in einer Benutzerdokumentation für Systeme ist alphabetisch geordnet. Zu jedem Begriff gibt es mindestens eine Referenz auf einer Textseite, wo der Begriff definiert (erklärt) oder verwendet wird. Mehrere Verweise sind durchaus möglich und sinnvoll. Das Stichwortverzeichnis in einem Handbuch für Systeme sollte möglichst vollständig alle für den Inhalt und den Benutzer interessanten Begriffe enthalten

Stichwortverzeichnisse müssen sinnvolle Verweise enthalten, z. B auf die Stelle, an der ein Begriff erklärt wird. Nicht jedes Auftreten eines Begriffs muss im Stichwortverzeichnis dokumentiert werden ( in einem Handbuch über Systeme müssten sonst sehr viele Verweise auf das Vorkommen von oder von Software stehen). Die Auswahl und Häufigkeit der Begriffe die in einem Stichwortverzeichnis stehen, muss daher sehr sorgfältig unter dem Gesichtspunkt des Nutzen für den Leser erfolgen. Weitere Verzeichnisse können Tabellen, Abbildungen, Beispiele etc aufzählen. Sonstige Bestandteile eines Benutzerhandbuches für Registrierkassen Systeme sind Vorwort, sowie Erläuterungen zum Aufbau und Umgang mit dem Handbuch. Anhänge enthalten Materialien, die für die Erläuterungen im Text nicht unmittelbar benötigt werden.

Tags:, , , , ,

Verwandte Artikel

Kommentieren

Letzte Kommentare
    Mai 2012
    M D M D F S S
    « Apr    
     123456
    78910111213
    14151617181920
    21222324252627
    28293031