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.

13.09.1991 - 

Das Handbuch in der Software bereitet noch manche Probleme

Die Online-Dokumentation via Textsystem flexibler machen

Die Online-Dokumentation findet nach überzeugenden Fortschritten im PC-Bereich zunehmend auch in Verbindung mit Mainframe-Anwendungen ihre Liebhaber. Heiner Göhlmann* beschreibt die Vor- und Nachteile dieser gespeicherten Handbücher und beschäftigt sich mit der Lösung, besonders im Großrechnerbereich auftretender Probleme.

In der Welt der Personal Computer hat die "Dokumentation von Anwendungen in sich selbst" innerhalb der letzten Jahre große Fortschritte gemacht - ein Beispiel dafür sind die Read.me-Dateien. Diese komfortablen Online-Hilfen moderner Windows-Applikationen sind ein Paradebeispiel für eine gelungene, benutzerorientierte Anwenderunterstützung.

Bei einer Dokumentation auf Papier liegen nicht selten einige Wochen Zeitverzug zwischen der Fertigstellung der Texte und der anschließenden Verfügbarkeit gedruckter Unterlagen, die dann zudem nicht mehr änderbar sind. Aus dieser Erkenntnis entwickelten sich in den Anfängen der PC-Ära eingangs erwähnte Read.me- oder Liesmich-Dateien. Diese Dateien enthalten Ergänzungen und Korrekturen zum gedruckten Handbuch.

Von Dialog-Programmen läßt sich dagegen die gesamte Dokumentation jederzeit aufrufen. Die Texte sind zusammen mit den Programmen auf die Datenträger kopiert und können damit genau dem Aktualitätsstand der Software angepaßt werden. Die Redakteure haben Zeit bis zur "letzten Minute", um auch die neuesten Änderungen und Ergänzungen zur Auslieferung bereitzustellen.

Texte lassen sich reproduzieren

Für Anwender ist außerdem vorteilhaft, daß die auf Datenträgern gelieferten Texte beliebig oft reproduzierbar sind. Dieser Pluspunkt wird jedem deutlich, der in der Groß-DV die Kosten für die Systemdokumentation großer Software-Anbieter betrachtet, die hier besonders hoch liegen.

Gerade die Anpaßbarkeit der Dokumentation bis zum Schluß verführt jedoch zu eilig geschriebenen Texten. Dabei sind Tippfehler neben einer fehlenden Textgestaltung und einer fehlenden automatischen Silbentrennung noch die erträglichsten Auswirkungen. Durchschlagender ist, daß in vielen Fällen die Redakteure umgangen werden, da die Produktentwickler die Texte selbst schreiben. Für komplexe Anwendungspakete sind oft viele Entwickler in dieser Weise tätig, daher ist eine Synchronisation des textlichen Arbeitsergebnisses nicht zu erwarten, vielmehr sind unterschiedliche Terminologien, Gliederungssysteme und Textgestaltungen üblich.

Besonders kritisch ist aus Sicht der Anwender eine Dokumentation, die maschinell aus sogenannten Data Dictionaries generiert wird. Dahinter steckt die Idee, alle Informationen jeweils nur einmal zu dokumentieren, um dann in beliebigem Zusammenhang darauf zu verweisen. Gerade bei solchen "synthetischen Dokumentationen" zeigt sich sehr schnell, daß die Summe vieler Teile noch lange kein ganzes ergeben muß. Dazu tragen zum Beispiel auch Default-Verweise bei, die unter Umständen zu seitenlangen Wiederholungen derselben Informationen führen, ohne daß die Dokumentationsgeneratoren dies entdecken oder unterdrücken.

Alle Funktionen werden beschrieben

Die Standarddokumentation beschreibt die Anwendungssysteme in ihrem Standard-Umfang. Dies bedeutet, daß alle Funktionen beschrieben werden, die die Software ermöglicht. Nun ist aber bei komplexen Anwendungssystemen, wie sie im Großrechner-Bereich eingesetzt werden, eine Auswahl einzelner Module oder Funktionen der typische Fall der Praxis, wodurch jedes System sein eigenes Profil erhält.

Nicht jede Dokumentationslösung ist in der Lage, diese Änderungen automatisch nachzuvollziehen und nicht benutzte Komponenten auch nicht zu dokumentieren beziehungsweise bei einer bestimmten ausgewählten Alternative dem Benutzer nur die für ihn verfügbare Version zu dokumentieren. Selbst wenn das grundsätzlich möglich ist, scheitern manche Systeme daran, die individuellen Änderungen in neue Versionen hinüberzuretten. Aus vorgenannten Gründen kommt bei den Anwendern oft der Wunsch auf, daß die maschinell verfügbare Dokumentation anwendungsspezifisch so bearbeitet wird, daß sie den Endbenutzern im Einzelfall hilfreich ist.

Programmbeschreibungen werden jedoch auch in schriftlicher Form gewünscht, sei es, um diese als Schulungsunterlagen an Seminarteilnehmer aushändigen zu können oder um das Handbuch unabhängig vom Bildschirm mit seiner limitierten Anzeigekapazität - auf Großrechnern auch heute noch meistens nur maximal 24 Zeilen zu je 80 Zeichen - studieren zu können. Es wäre jedoch schade,

wenn die durchaus richtigen Überlegungen für eine Online-Dokumentation aufgrund der mangelhaften Umsetzung und technischen Unzulänglichkeit heutiger Großrechner-Anwendungen in Verruf käme. Vielmehr sollte eine Überleitung der Online-Dokumentation in die Welt der Textsysteme ermöglicht werden, um die Standarddokumentation mit geeigneten Produkten, etwa "Word für Windows" von Microsoft, zu bearbeiten.

Dieser Weg ist heute jedoch noch recht mühsam: Wenn es gelingt, die Texte der Online-Dokumentation mit Standardmitteln in eine "Druckdatei" zu übertragen und durch Filetransfer oder PC-Down-loading als PC-Datei maschinenlesbar und damit für die Textsysteme importierbar zu machen, bleibt eine Vielzahl formaler Fehler, für die ein Umsetzprogramm zweckmäßig wäre.

Bei Dateien, die vom Großrechner auf den PC übertragen werden, gilt zum Beispiel jede Druckzeile der Dokumentation als ein Datensatz. Beim Importieren in die Textsysteme wird mangels anderer Steuerzeichen im allgemeinen aus jeder Zeile ein Absatz. Damit ist genau das nicht mehr sinnvoll möglich, was die Stärke von Textsystemen ausmacht: die Formatierbarkeit der Absätze.

Ferner erfolgt mit den Standardmitteln der Anwendungssoftware oft ein, für die maschinelle Weiterbearbeitung störende Aufbereitung mit Seitenköpfen und -füßen - dies führt beim Seitenwechsel zu Leerzeilen. Zudem unterscheiden sich die von den Autoren eingefügten Bindestriche zur Silbentrennung nicht von Bindestrichen, die als Mittelstriche für zusammengesetzte Wörter erhalten bleiben sollen.

Großbuchstaben nicht lesefreundlich

Eine unfeine Art mancher Dokumentationen auf dem Großrechner ist die Rücksichtnahme auf die begrenzte Darstellungsfähigkeit von Datenstationen und Systemdruckern für Sonderzeichen. Manche Anbieter gehen dabei nicht nur soweit, daß sie alle Umlaute umgehen (aus "ö" mach "oe"), sondern sie bieten auch die Texte in Großbuchstaben an. Daß dadurch die Lesbarkeit erheblich beeinträchtigt wird, kann jeder Anwender bestätigen, der gezwungen ist, mit solchen Dokumentationen zu arbeiten. Die Benutzer sollten allen Textern dankbar sein, die auf Silbentrennungen und Großschreibung verzichten und die außerdem Fließtext von gestaltetem Text, zum Beispiel Tabellen, durch eine geeignete und einheitliche Gestaltung unterscheidbar machen . Zur Erkennung genügt dabei oftmals ein Leerzeichen oder ein bestimmtes Sonderzeichen in der ersten Stelle einer jeden Tabellenzeile. Sind jedoch diese Hürden genommen, steht einer Anpaßung an die speziellen Dokumentationsbedürfnisse der Benutzer nicht mehr viel im Wege. Mit den modernen Textsystemen, wozu auch PCs gehören, fällt es dem Anwender leicht, Textstellen hervorzuheben, wegzulassen oder an die firmenspezifische Terminologie anzugleichen. Ebenso wichtig ist die Möglichkeit, die firmenspezifischen Regeln zur Anwendung der Software durch einfache Textbearbeitung in den Standardtext einbringen zu können. Dabei lassen sich auch Gliederungen sowie Inhalts- und Stichwortverzeichnisse erstellen. Soweit die Dokumentation auf dem PC verfügbar bleibt, könne unter anderem im Text nach Zeichenfolgen gesucht sowie neue Schlagwortverzeichnisse erstellt werden. Außerdem steht es dem Anwender frei, durch die Formatierung eine firmenübliche Gestaltungen kompletter Dokumente zu realisieren, und seien es nur so scheinbar banale Sachen wie Schriftarten und Papierformate.

Rechtliche Aspekte müssen berücksichtigt werden

Schließlich sind neben den technischen auch die rechtlichen Aspekte, wie das Urheberrecht, zu berücksichtigen. Dabei ist es eigentlich unnötig, daß zu jeder - auch nur auszugsweisen - Kopie einer angepaßten Systemdokumentation die "vorherige und schriftliche" Zustimmung des Lizenzgebers zu erbitten ist.

Durch ein entsprechendes Entgegenkommen der Lieferanten und die entsprechenden Forderungen der Einkäufer wäre es hier sicher möglich, eine für beide Seiten akzeptable Vereinbarung zu erzielen.

DV-Organisatoren, die das Ziel verfolgen, den Endanwendern eine am Bedarf und an den Erwartungen der Benutzer orientierte Anwendungsdokumentation zu übergeben, sind den Textern für die technischen Vorarbeiten und den Lieferanten und Einkäufern für die rechtlichen Freiräume dankbar. Letztlich wird durch eine gute Dokumentation auch die Akzeptanz der Software insgesamt unterstützt, was im Interesse aller Beteiligten liegt.