Hardwarebeschreibung,

Die Hardwarebeschreibung ist eine technische Beschreibung der Maschine und der konfigurierten Geräte. Sie sollte die Anschlussmöglichkeiten für die Geräte beschreiben und die gesamte Inbetriebnahme der Hardwarekomponenten erläutern.

Systembeschreibung (Software),

Die Systembeschreibung ist eine Beschreibung des Betriebssystems mit allen seinen Teilen wie zum Beispiel Dienstprogrammen und Hilfsroutinen für Systemverwaltungsarbeiten. Sie sollte die Voraussetzungen für die Inbetriebnahme des Systems und den Ablauf dieses Vorgangs beschreiben. Die einzelnen Bedienungsschritte sollten im Detail erläutert, Meldungstexte insbesondere Fehlermeldungen übersichtlich und verständlich zusammengestellt werden. Der Anwender muss zumindest in Ausnahmefällen in der Lage sein, dies anhand der Beschreibung selbst vorzunehmen.

Anwendungsbeschreibung

Die Anwenderbeschreibung ist eine funktionale Beschreibung dessen, was das Anwendersystem leistet. Sie sollte die vom System zu bearbeitenden fachlichen Aufgaben und deren Lösung darlegen. Sie setzt fachliche Kenntnisse voraus, ohne selbst Branchenwissen vermitteln zu wollen.

DV-technische Beschreibung

Die DV-technische Beschreibung, ist die Beschreibung der zu der fachlichen Konzeption gefundenen DV-technischen Lösung. Sie sollte einen Datenflussplan, Programmbeschreibungen, Daten- und Dateibeschreibungen, Methoden der Datenorganisation und des Datenzugriffs beinhalten.

Generierung- und Bedienungsanleitung.

Die Generierungsanleitung ist die Beschreibung der Inbetriebnahme der Anwendersoftware, das heißt der Installation des Anwendersystems. Sie sollte beschreiben, welche Geräte und Datenträger benötigt und wie sie initialisiert werden. Sie erläutert das Einbringen von Anwenderdaten, Parametern, Steuercodes und enthält ein Verzeichnis aller zu generierenden Programme, Dateien und Parameter. Die Generierung muss vom Anwender selbst durchgeführt werden können.

Die Bedienungsanleitung ist die Beschreibung der einzelnen Bedienschritte für den Einsatz der Anwendersoftware. Sie ist die für den Anwender wesentlichste Schrift, weil er damit am häufigsten arbeiten wird. Daher muss nicht nur das Vorhandensein dieser Unterlage gewährleistet sein, sondern auch geprüft werden, ob sie richtig und verständlich ist. Der Anwender sollte vor allem darauf achten, dass folgende Punkte darin enthalten sind.

• Beschreibung der benötigten Abläufe in der richtigen Reihenfolge,

• dazu bereitzustellende Programme, Dateien, Daten und Datenträger,

• detaillierte Beschreibung der vom Bediener durchzuführenden Tätigkeiten,

• Reaktionen des Systems nach den genannten Bedienschritten,

• Beschreibung zyklisch wiederkehrender Abläufe getrennt von etwaigen organisatorisch bedingten Sonderfällen (zum Beispiel Geschäftsjahreswechsel),

• Beschreibung des Normalfalls getrennt vom Fehlerfall,

• im Fehlerfall zu ergreifende Maßnahmen (manueller oder maschineller Art),

• Fortsetzen der Verarbeitung nach Fehlerbehebung,

• Rekonstruktion der durch fehlerhafte Verarbeitung verlorenen oder zerstörten Daten,

• Maßnahmen bei unbeabsichtigter Zerstörung oder Verlust von Daten,

• vollständige Liste von Systemmeldungen, insbesondere von Fehlermeldungen seitens der System- und Anwendersoftware,

• exakte Beschreibung eines Aufrufs für Programm, Prozedur und Kommando, auf welche Weise die Aufruffolge am Bedienplatz einzugeben ist, sowie eventueller vom System abzuwartender Reaktionen,

• Beschreibung der Dateneingabe am Bildschirm mit der genauen Wiedergabe des Benutzerdialogs, der Abbildung der Masken im Bedienerhandbuch und der vor der Eingabe zu schaffenden Voraussetzungen. Hierzu gehören zum Beispiel das Bereitstellen von Datenträgern, das Sortieren von Daten oder eventuell auszuführende Nacharbeiten

• und schließlich die positive Beschreibung von Bedienungsabläufen unter dem Gesichtspunkt "was ist zu tun, damit es funktioniert". Strikt hiervon zu trennen ist die Beschreibung von Sonder- und Fehlerfällen.
  
  

Diese Liste dringend benötigter Dokumentationen kann als Checkliste bei der Anwendungsübernahme dienen. Zumindest müssen die Summen der Beschreibungen und der hier stichwortartig erwähnten Inhalte dokumentiert sein, auch wenn es im konkreten Fall weniger Einzelbeschreibungen sein mögen.

Gemeinsam für alle Anwenderdokumentationen gilt:

• Sie müssen lesbar, transparent, verständlich, einheitlich, vollständig, aktuell und fehlerfrei sein und komprimiert und benutzergerecht abgefasst sein, um einen hohen Gebrauchswert zu haben.

• Sie müssen in Bezug auf Stil und Wortwahl den Bedürfnissen des Benutzers/Anwenders dienen. Eine technische Beschreibung sollte in einwandfreiem Deutsch und nicht im Entwickler- oder EDV-Slang mit eingedeutschten Amerikanismen abgefasst sein. Abkürzungen und Begriffe werden bei ihrer Einführung einmal erläutert. Aussagefähige grafische Darstellungen (Tabellen, Matrizen, Diagramme) können lange Texte ersetzen.

• Register und Inhaltsverzeichnis erschließen eine Beschreibung. Das Titelblatt sollte folgendes enthalten:

• einen eindeutigen Titel mit Angaben in Bezug auf Überarbeitung, Version, Übersetzung oder dergleichen, den Namen des Verfassers und das Datum der Fertigstellung.

• ein Vorwort mit Verweisen auf weitere Schriften, in deren Zusammenhang die vorliegende einzuordnen ist. Es gibt einen Hinweis, auf welche Version der Anwender- und/oder Systemsoftware sich die vorliegende Beschreibung bezieht. Im Vorwort sollte schließlich kurz dargelegt sein, welche Kenntnisse und Voraussetzungen der Leser oder Benutzer besitzen muss, um mit dieser Beschreibung arbeiten zu können. 
  
  

Von entscheidender Wichtigkeit für jeden EDV-Anwender ist das Nachführen der Dokumentationen bei Änderungen am und im System. Nur wenn alle Änderungen vollständig und konsistent dokumentiert sind und sich die Änderungsbeschreibungen auch nahtlos in die bestehenden Beschreibungen einfügen lassen, kann der Anwender effektiv mit einem geänderten System arbeiten.

Ziel des Anwenders sollte es sein, ein ihm übergebenes Anwendersystem nur dann abzunehmen (das heißt zu kaufen oder zu mieten), wenn es vollständig und richtig dokumentiert ist. Der Anwender hat hier eine Chance, die er im eigenen Interesse nutzen sollte!

Bei Absprachen über Preise und Wartungspflicht für Hard- und Software sollte der Anwender darauf achten, dass darin auch die Dokumentation enthalten ist. Sie ist ein wesentlicher Bestandteil des vom Anwender erworbenen Produktes. Ebenso muss mit Übergabe der Dokumentation dem Anwender ein für diese Beschreibungen zuständiger Gesprächspartner beim Hersteller benannt werden.

Dokumentationen sollten kopierfähige Unterlagen sein, was Format, Papier- und Druckqualität sowie die Verwendung von farbigen Vorlagen angeht. Zusätzlich sollte genügend Platz für Anmerkungen des Anwenders vorgesehen sein. Dokumentationen gehören nicht in den Schrank, sondern sind Arbeitsmittel wie der Rechner selbst