Technische Dokumentation für Web-Anwendungen

Was sind Web-Anwendungen?

Das WWW (World Wide Web) bietet nicht nur die Möglichkeit, Informationen anzuzeigen, sondern insbesondere auch, Interaktivität in die Web-Seiten einzubauen. In HTML stehen dazu Formulare mit Dialogelementen zur Verfügung, wie sie aus anderen grafischen Oberflächen, zum Beispiel Windows bekannt sind. Es gibt Schaltflächen, Eingabe-, Listen-, Kontroll- und Optionsfelder. Diese Möglichkeiten kann sich die Anwendungsentwicklung zu Nutze machen. So entstehen Web-Anwendungen mit HTML-basierten grafischen Bedienoberflächen, die sich über einen Web-Browser anzeigen und bedienen lassen. Die Anwendung läuft auf einem Server. Handelt es sich um einen Web-Server, können sich die Benutzer über ihren Web-Browser direkt mit der Anwendung verbinden. Es gibt öffentliche Anwendungen, die für jeden frei zugänglich sind, sowie geschützte Anwendungen, die eine Anmeldung mit Benutzer-ID und Passwort erfordern.

Ein Beispiel für öffentliche Web-Anwendungen ist die Fahrplanauskunft der Deutschen Bahn. Hier können Sie sich komfortabel über Verbindungen informieren, Fahrkarten bestellen und Plätze reservieren.

Aber nicht alles ist mit HTML machbar. Es gibt beispielsweise keine Menüs, weder Aufklapp- noch Popup- oder Kontextmenüs. Technische Lösungen mit Java sind möglich, führen aber zu Laufzeitproblemen, die selbst heute oft noch für die Benutzung inakzeptable Dimensionen erreichen. Daher sind Oberflächen eher schlicht gehalten; der Leitspruch lautet: weniger Dynamik, mehr Navigation.

Fahrplanauskunft der Deutschen Bahn

Wie verändert das Web die Dokumentation?

Die Grenzen zwischen Anwendung und Dokumentation sind fließend und kaum noch auszumachen. Bedienoberfläche und Bedienhilfe verschmelzen zu einem Ganzen. Keiner muss lange oder vergeblich nach Help-Texten suchen, denn die benötigte Unterstützung wird direkt im Browser-Fenster angeboten. Abgestimmt auf individuelles Bedienverhalten und aktuelle Bediensituation wird durch die Anwendung geführt, bis die gewünschte Information greifbar ist.

Handbuch
Klassische Handbücher, die auf Papier gedruckt ausgeliefert werden, wird es kaum noch geben. Denn bei Internet-Anwendungen, die zum Teil weltweit angeboten werden, sind die potenziellen Kunden meist nicht bekannt. Elektronische Dokumentation als pdf-Datei zum Downloaden bleibt hier die einzig sinnvolle Handbuchalternative. Ausdrucken ist dann Kundensache.
Wo es noch Handbücher gibt, ändern sich die Inhalte. Sie beschränken sich immer mehr auf prinzipielle sowie konzeptionelle Aspekte und sind weniger konkret. So kann es riskant sein, die Bedienoberfläche abzubilden; denn abhängig vom verwendeten Browser kann dieselbe Anwendung völlig unterschiedlich aussehen.

Online-Hilfe
Obwohl bei Windows-Anwendungen nahezu selbstverständlich, wird die Online-Hilfe für Web-Applikationen bislang noch als Rarität gehandelt. Liebgewonnene Features wie Popups, Zweitfenster, kontextsensitive Help-Texte, generierbare Inhalts- und Stichwortverzeichnisse sowie Volltextsuche halten nur zögernd Einzug in die HTML-basierte Hilfe-Welt. Statt dessen behaupten sich immer noch schlicht (um nicht zu sagen: puristisch) gestaltete, textlastige HTML-Seiten, die bereits als fortschrittlich gelten, wenn sie kontextsensitiv zum aktuellen Fenster sind.

Online-Hilfe zur Fahrplanauskunft

Hinsichtlich der Hilfetexte bleibt zu hoffen, dass es zu einer Abkehr von stupiden Schrittanleitungen kommt wie: "Um die Funktion abzubrechen, klicken Sie ABBRECHEN." So eine Hilfe hilft niemandem. Gefragt sind vielmehr Hintergrundinformationen, inhaltliche Zusammenhänge sowie echte Unterstützung bei Fehlern und sonstigen Problemen.

Mehrsprachigkeit
Was für Websites zutrifft, gilt auch für Software-Oberflächen im Web. Mehrsprachigkeit ist gefordert. Aber erste Erfahrungen zeigen, dass es hier noch viel zu tun gibt.

Englische Version der Fahrplanauskunft

Die Windows-Welt kennt zahlreiche Hilfsmittel zur Verwaltung und Übersetzung von Oberflächentexten. Auf solche Tools müssen wir leider in der HTML-Welt vorerst noch verzichten. Statt dessen ist echte Handarbeit gefragt. Daher ist es oberstes Gebot, bereits bei der Erstellung von Oberflächen auf ihre Übersetzbarkeit zu achten.

Wichtige übersetzungsrelevante Aspekte sind:

Leicht editierbare Texte, zum Beispiel keine Texte innerhalb aufwendiger Grafiken
Verwendung von Style-Sheets, um konsistente Formatierung bei Quell- und Zielsprache zu gewährleisten
Möglichst Einsatz derselben Tools sowohl für die Erstellung als auch für die Übersetzung, damit unliebsame Überraschungen durch tool-spezifische Eigenheiten vermieden werden können.

Fazit

Die getrennte Realisierung von Software-Oberfläche und Dokumentation wird zunehmend problematisch. Wenn wir Online-Hilfen schreiben, müssen wir die Entwicklungsquellen ändern, ergänzen und zum Teil neu erstellen. Das erfordert nicht nur intensive Kooperation und Kommunikation mit der Entwicklung, sondern auch die Bereitschaft, einige Aufgaben, wie die Gestaltung der Bedienoberfläche, auf die Dokumentationsseite zu verlagern. Zudem ist Experimentierfreude gefragt. Neue technische Möglichkeiten in HTML liefern interessante Aspekte und Ideen, die wir in der Dokumentation gewinnbringend umsetzen können.