Melden Sie sich hier an, um auf Kommentare und die Whitepaper-Datenbank zugreifen zu können.

Kein Log-In? Dann jetzt kostenlos registrieren.

Falls Sie Ihr Passwort vergessen haben, können Sie es hier per E-Mail anfordern.

Der Zugang zur Reseller Only!-Community ist registrierten Fachhändlern, Systemhäusern und Dienstleistern vorbehalten.

Registrieren Sie sich hier, um Zugang zu diesem Bereich zu beantragen. Die Freigabe Ihres Zugangs erfolgt nach Prüfung Ihrer Anmeldung durch die Redaktion.

28.02.1986 - 

Hardwarebeschreibung bereitet weniger Kopfzerbrechen als Softwaredokumentation:

Beim Handbuch stehen sich Computer häufig selbst im Wege

Ohne Dokumentation kann man Software im Normalfall nicht rationell einsetzen. Leider eignet sich aber gerade bei der Erstellung von Handbüchern der Computer selbst nur bedingt. Wie man jedoch trotzdem zu einer sinnvollen Beschreibung der weichen Ware kommen kann, zeigt der folgende Bericht anhand von einschlägigen Mängellisten. Tips und Leistungsmerkmalen auf.

Mit der von Spezialisten geschriebenen Software müssen in der Regel DV-Laien arbeiten, vor allem, wenn es sich um Standard- und Anwendersoftware handelt. Aber auch Systemsoftware (Betriebssysteme oder Teile davon, wie Compiler, Interpreter, Utilities) muß so dokumentiert sein, daß nicht nur der eigentliche Urheber (Programmierer) damit etwas anfangen kann.

SW-Dokumentation ist mehr als nur karge Beschreibung

Wie wirkungsvoll Programme eingesetzt werden können, hängt nicht zuletzt von der Anleitung für den Benutzer ab. Beim harten Kampf mit der neuen DV-Materie entpuppt sich manche Bedienungsanleitung als mangelhafte Einstiegs-, Schulungs- oder Nachschlageunterlage.

Hintergrundwissen, Arbeitsinhalte und Bedienungsschritte müssen für die jeweilige Zielgruppe also sehr verständlich dargestellt sein. Gute Softwaredokumentation ist demnach mehr als nur karge Funktionsbeschreibung für Profis.

Dies haben die Hersteller zum Teil erkannt. Aber nur sehr zögernd wird Geld für bessere Handbücher und andere DV-Dokumente investiert. Und das, obwohl durch die Vielzahl von Produkten (vor allem im PC-Bereich) und durch immer mehr Einsteiger ohne DV-Vorkenntnisse manuale und weiterführende Bücher rasch an Bedeutung gewinnen.

Viel zu oft erscheinen heute noch exzellente Produkte mit minderwertiger Dokumentation auf dem Markt, weil den Herstellern Zeit und Geld dafür zu schade sind. Noch ist den Marketing- und Vertriebsmanagern offensichtlich nicht genügend bewußt, daß gute Dokumentation die Vermarktung fördert und die Anwenderunterstützung vereinfacht.

Insbesondere für dialogorientierte DV-Systeme gibt es eine ganze Reihe von Möglichkeiten, um Informationen zur Unterstützung des Anwenders zu vermitteln. Schulungssoftware, beliebig abrufbare Informationstexte oder Hilfsfunktionen (mögliche Bedienungsschritte werden am Bildschirm angezeigt) sind einige Beispiele. Dokumentation in dieser Form bietet ohne Frage Vorteile.

Man muß dabei bedenken, daß der Weg, die notwendigen Informationen vollständig über den Bildschirm auszugeben (Online-Manuals, Help-Texte), einer hinreichenden Bedienerdokumentation, nur sehr begrenzt gerecht werden kann.

So läßt mangelnder Platz lediglich eine verkürzte und sprachlich unaufbereitete Information zu; Grundlagen werden nicht vermittelt und Zusammenhänge lassen sich nicht ausreichend verdeutlichen. Außerdem ist es nicht möglich, unterschiedliche Vorkenntnisse des Benutzers und individuelle Lese- und Lerngewohnheiten zu berücksichtigen (blättern, nachlesen, Überblick verschaffen). Ferner entfällt die intensive Information in Einführungsphasen und die Nutzung als Nachschlagewerk für spezielle Problemstellungen.

Neue Techniken zur ständigen Anwenderunterstützung mit Hilfe moderner Medien wie Bildplatte oder Video sind noch nicht ausgereift und zusätzlich kostenintensiv.

Bedienungsanleitungen, Programmier- und Sprachhandbücher oder Produktbeschreibungen werden daher auch in Zukunft eine wichtige und notwendige Vermittlungsfunktion zwischen Mensch und Hard- beziehungsweise Softwaresystemen übernehmen.

Zwar ist klar, daß die Benutzer ein Handbuch nicht immer so intensiv nutzen werden wie in der Einführungsphase. Beim Einstieg wird es als Arbeitsunterlage gebraucht, um nach einer Lernphase als Nachschlagewerk für eine spezielle Problemstellung zu dienen. Dennoch zeigt sich hier ein weiterer Vorteil gut dokumentierter Software: Das Benutzerhandbuch kann Schulungsunterlage sein, die die Undurchschaubarkeit großer Systeme aufhebt.

Handbücher entstehen meist in Hetze

Anleitungen für die Hardware wurden und werden generell weniger stiefmütterlich behandelt als Erläuterungen für die Nutzung von Programmen. Hardwarebeschreibungen

verlassen sich in größerem Ausmaß auf Illustrationen. Zeichnungen und Detailaufnahmen erklären den Gegenstand oft schneller und besser als Worte. Über Hardware zu schreiben ist nach Ansicht von Herstellern einfacher. Es werden Dinge besprochen, die der Anwender sehen und anfassen kann.

Komplexe Softwareprozeduren zu veranschaulichen erfordert dagegen noch mehr Einfühlungsvermögen, größeres Geschick und eine spezielle Qualifikation, die sich nicht nur auf EDV-Know-how beschränkt, sondern auch redaktionelle und didaktische Qualitäten des Texters verlangt.

Die Erstellung von Softwarehandbüchern unterliegt besonderen Bedingungen, die zu guten oder schlechten Resultaten führen. Meist wird die Dokumentation nach Fertigstellung der Software entwickelt.

Der Korrektur des Manuskripts wird wenig Zeit zugestanden, und Aktualisierungen erfolgen in letzter Minute.

Diese Hetze führt zwangsläufig zu Qualitätseinbußen. Mit dem Schreiben und Umschreiben sollte nach Meinung von Experten viel früher, zumindest parallel zur Softwareentwicklung, begonnen werden. Denn sobald der Text in Satz geht, ist es für die Beseitigung von Ungereimtheiten zu spät.

Das Manuskript sollte zusammen mit der Software getestet werden, um sicherzustellen, daß es ein verläßlicher Führer ist. Andernfalls geraten Kosten und Termine leicht außer Kontrolle. Gerade deshalb kann es sich für DV-Hersteller und große Anwender lohnen, externe Spezialisten als Berater ( "TÜV" für die DV-Dokumentation) einzubeziehen.

Der Anwender soll seinen "Senf" dazugeben

Selten sind sich DV-Anwender darüber im klaren, daß sie selbst durch Rückmeldung beim Hersteller für die Beseitigung von Mängeln sorgen können.

Der User könnte also entscheidend dazu beitragen, DV-Dokumentation zu verbessern. Hersteller haben erklärt, daß die vom Benutzer gemeldeten Probleme nicht nur zur Berichtigung der Handbücher, sondern in bestimmten Fällen auch zu strukturellen Veränderungen der Programme selbst geführt hätten.

Nachdem zum Beispiel die Beschreibung komplizierter Prozeduren durch genaue Erläuterungen der einzelnen Programmschritte ergänzt worden waren, verringerten sich die Anfragen um 90 Prozent. Anwender, die ihr Handbuch studiert hätten, gäben die brauchbarsten Hinweise auf Schwachstellen der Software. Die befragten Hersteller bestätigen auch, daß diese Gruppe am seltensten auf sie zukomme und um Unterstützung nachsuche.

Die Fachterminologie gehört in ein Glossar

Für den Anwender stellt sich die Frage, wie er beim Einkauf von Programmen erkennen kann, ob die mitgelieferte Dokumentation den praktischen Einsatz unterstützt. Keine einfache Aufgabe! Die Erfahrung von Softwareentwicklern und Softwareanwendern hat aber gezeigt, daß es immer wieder auf einige grundlegende und allgemeingültige Regeln ankommt, die eingehalten werden müssen.

Gute Handbücher zeichnen sich unter anderem durch ein so trivial anmutendes Merkmal wie ein klar gegliedertes, detailliertes Inhaltsverzeichnis aus. Sie enthalten ein umfassendes, alphabetisch geordnetes Stichwortverzeichnis. Die Einleitung sollte über Aufgaben und Einsatzmöglichkeiten des Produkts informieren und eine Zusammenfassung der Funktionen enthalten. Sinnvoll kann eine Übersicht über die wichtigsten Verwaltungsroutinen sein.

Die Sprache, in der ein Handbuch geschrieben ist, muß für den jeweiligen Anwenderkreis verständlich, also kein EDV-Fachchinesisch sein. Unvermeidliche Fachterminologie ist in einem Glossar zu kommentieren. Handbücher sollten eine Aufstellung über eventuell auftretende Probleme, über deren Ursachen und mögliche Abhilfemaßnahme enthalten (zum Beispiel Liste von Fehlermeldungen mit Reaktionsmöglichkeiten). Die Texte müssen leserfreundlich strukturiert sein (Fettdruck, Überschriften und Unterstreichungen). Illustrationsmittel, wie Fotografien, Zeichnungen und Abbildungen, haben sich in der Praxis als Handbuchelemente erwiesen, die den Lernprozeß unterstützen.

Schließlich sollte eine vollständige Dokumentation auch eine Einweisung in die Handhabung des Systems, die alle für den Benutzer relevanten Arbeitsschritte umfaßt (zum

Beispiel Systemstart, Arbeitsbeginn), eine ausführliche Erklärung sämtlicher Kommandos und ihre Wirkungsweise und (versehen mit Illustrationen) einen Sonderteil für Spezialisten wie Programmierer, der alle technischen Details bespricht, enthalten.

Technische Redakteure sind zunehmend gefragt

Nach der Krieger/Zander-Skala getestete Handbücher zu Textverarbeitungsprogrammen erhielten zum Teil katastrophale Noten. Wobei gesagt werden muß, daß nicht die Programme bewertet wurden, sondern die mitgelieferte Dokumentation.

DV-Hersteller gehen aus naheliegenden Gründen vermehrt dazu über, statt Softwareerstellern Dokumentationsspezialisten für die Handbucherstellung einzusetzen

("Technische Redakteure").

Anwender mit eigener DV-Abteilung, die Programme für ihre Fachabteilungen selber erstellen, sollten ebenfalls die genannten Kriterien für ihre Dokumentation berücksichtigen oder extern erstellte Dokumentationen daran spiegeln. Wer fleißig darauflosprogrammiert, ohne an die Sachbearbeiter am Terminal zu denken, darf sich nicht wundern, wenn Rückfragen überhandnehmen.

Viktor Burdich ist Geschäftsstellenleiter und Dieter Krause PR-Manager bei der Team Partner für Technologie und angewandte Methoden der Informationsverarbeitung GmbH, Recklinghausen.