Kapitel 10: Dokumentation (S. 195-197)

… in dem die Informationen aus dem User Interface-Modell zum Gerüst für Handbücher und für das Hilfesystem werden.

Kapitelziele
• Handbuch und Hilfe zeitgleich mit der Software liefern.
• Automatisierte Übernahme der anleitenden und beschreibenden Teile des UI-Modells in das Gerüst der Benutzerdokumentation.
• Automatisches Erzeugen von Screenshots aus der Bildschirmbeschreibung in der UI-Spezifikation.
• Informationen über Änderungen am UI automatisiert an Verfasser der Dokumentation liefern (z.B. auf neu hinzugekommene oder entfallene Teile des UI hinweisen).

Eine Benutzerdokumentation beschreibt, wie die Oberfläche der Softwareanwendung funktioniert. Ein User Interface, das nicht beschrieben ist, gleicht einem Abenteuerspiel. Der Anwender muss raten und rätseln, ob das beobachtete Verhalten der Softwareoberfläche so gewollt oder ein Fehler ist. Funktionalitäten, die nicht offensichtlich sind, bleiben dem Anwender verborgen, bis sie zufällig oder durch systematische Detektivarbeit entdeckt werden. Versehentlich ausgelöst, führen unbekannte Funktionalitäten zu weiteren Irritationen der Anwender.

Es ist daher von Nutzen, wenn bereits mit der ersten UI-Version, die vom Entwicklungsteam bereitgestellt wird (auch dann, wenn diese erste Version die Endanwender niemals sehen werden) eine UI-Dokumentation (oder eine andere Form der Sollverhaltenbeschreibung) mitgeliefert wird. Sie erleichtert den Anwendervertretern den Einstieg, hilft Missverständnisse zu vermeiden und gibt Aufschluss darüber, was man von der Software erwarten kann und was nicht.

Eine manuell erstellte Dokumentation beschreibt das UIVerhalten der Anwendung nachträglich. Ein User Interface- Modell, vorausgesetzt, dass es im Projekt ernst genommen wurde, beschreibt vorab, wie die Oberfläche der Softwareanwendung funktionieren soll. Selbstverständlich haben beide Beschreibungsformen unterschiedliche Schwerpunkte und unterschiedlichen Aufbau. Jedoch enthält die Vorabbeschreibung der Oberfläche im UI-Modell Informationen über Aufbau und Bedienung der Anwendung, die auch in der Benutzerdokumentation von Belang sind. Die in einem User Interface-Modell enthaltenen Informationen können also für das Erstellen verschiedener Dokumente herangezogen werden.

Aus einem hinreichend formalisierten UI-Modell kann man zum Beispiel die strukturierenden und die anleitenden Teile automatisiert in ein Gerüst für die zu erstellende Benutzerdokumentation umwandeln. In ähnlicher Weise lassen sich Berichte über den Entwicklungsstand der Oberfläche und Versionsinformationen generieren. Die aus einem UI-Modell ableitbaren Dokumente lassen sich in drei Kategorien gliedern:
• Entwicklungsdokumente,
• Benutzerdokumente und
• Dokumente zur Änderungsverfolgung.

10.1 Entwicklungsdokumente generieren

UI-bezogene Entwicklungsdokumente sind meist Bestandteil von Designstudien oder Feinkonzepten. Manuell erstellte UI-Design- Dokumente müssen stets auf den neuesten Stand gebracht werden, weil Designentscheidungen auf Basis von ausführbaren UIPrototypen erfolgen. Diese Nachdokumentationsarbeit kann eingespart werden, wenn die ausführbaren Prototypen und die UI-Dokumente mit geeigneten Transformationen aus demselben UI-Modell erzeugt werden. Entwicklungsbegleitende UI-Dokumente können zum Beispiel sein:

• Aufstellungen, die Entwicklern beim Codieren helfen:
– Liste der Dialogseiten
– Liste von Kontrollelementen pro Dialogseite
– Liste von Kontrollelementen pro Kategorie mit Vorkommen- Aufzählung – Liste der Aufrufe von Anwendungsfunktionen pro Dialogseite – Liste der Aufrufe von Anwendungsfunktionen pro Funktionsgruppe mit Vorkommen-Aufzählung

• Abnahme- und freigaberelevante Projektdokumente:
– Dialogseitenbeschreibungen,
– Übersichten über die Ablaufstruktur der Oberfläche,
– Spezifikationsdokumente, die automatisch aus dem UIModell generiert wurden.