Benutzer-Leitfaden
Manuelle Justage
Auswertung der Lösungen
Uli Sacklowski, 05.02.01
1. Allgemeine Einschätzung
-
Aufgabe war anspruchsvoll und praxisrelevant
-
Lösungen überwiegend sehr gut
-
Teile bereits in unsere zentralen web-Dokumente übernommen (Glossar)
-
Aussagen flossen in unsere Benutzer-Handbücher-Vorgaben ein
-
Nicht angenommen wurde das Angebot der stichpunkt- bzw. anstrichartigen
Kompaktform und der alleinige Verweis auf Grafiken (z.B. übersicht
zur manuellen Justage)
-
Kein Vergleich mit anderen Benutzer-Dokumenten
2. Herangehensweise, Wissensdefizite, Detailprobleme
-
Im Wesentlichen haben wir unsere Aufmerksamkeit darauf gerichtet, den Ablauf
des/derjenigen nachzuempfinden, der/die die Messungen durchführt und
daraufhin die am Rechner durchzuführenden Schritte mit der Software
beschrieben, bevor wir die vorgeschlagenen Aspekte des Herrn Balzert berücksichtigt
haben.
-> immer zweiseitig?
-
Pkt. Beispiel-Abläufe:
... ausserdem haben wir keinerlei praktische Erfahrungen mit Software oder
Geraet, so dass wir auch keine sinnvollen Beispiele anfuehren koennten.
-> Benutzer-Handbücher setzen u.a. Kenntnisse bzgl. Produkt, Nutzer
und Anwendungsbereich voraus
-
Sprachkonsistenz:
Auf eine einheitliche Bezeichnung der Bedienelemente (z.B. Taste oder Button,
Laufleiste oder Scrollbar) konnten wir uns nur schwer einigen.
-> relevantes Problem !!
-
Sprachkonsistenz:
Die Screenshots der Dialogbox "Manuelle Justage" waren im Pflichtenheft
in Deutsch, im Programm develop.exe, welches uns zur Verfügung stand,
jedoch in Englisch.
-> gibt auch deutsche Variante
-
Referenzen:
Eine Referenz auf die benötigten Funktionen des Hauptprogrammes (Bsp.
Einstellung der Detektoren) ließ sich schwer einbauen.
-> Lösung: unsere Benutzerleitfäden werden modular und hierarchisch
3. Relevanz und Bewertung der Benutzer-Handbücher von Balzert
-
Relevanz der Handbücher:
Die Punkte der Mustergliederung sind zwar alle wichtig.
Je nach Anwendung und Zielpublikum wird aber gelegentlich der eine oder
andere Teil wegfallen können: z.B. wird bei einem Wiedergabeprogramm
für Videos, das nur eine "Play", "Stop" und "Pause" Taste besitzt,
ein Tutorial wohl wegfallen können.
Eine Serverapplikation, die von der Kommandozeile gestartet wird, wird
nicht die Benutzeroberfläche (Shell) dokumentieren, sondern sich im
Referenzteil auf die möglichen Optionen beim Start des Server konzentrieren.
Und nicht jedes Computerspiel benötigt ein Literaturverzeichnis.
-
Widersprüche Aussagen hinsichtlich der Eignung der Gliederung
a) Alles in allem ist die Gliederung Balzert fuer maechtigere
Software als das beschraenkte Tool geeignet.
b) Für unser Beispiel ist die Gliederung recht
gut geeignet.
Da wir nur ein Subsystem dokumentieren, würden einige Teile (Abkürzungsverzeichnis,
Glossar, Register) wohl auf einer höheren Dokumentationsebene liegen
und wir würden die Einträge dort einordnen, evtl. würden
wohl auch der Referenzteil und das Literaturverzeichnis als Hauptabschnitte
geführt.
-> ???, Diskussion unserer Benutzerleitfäden
-
Fehlender Punkt:
Es gibt einen wichtigen Teil, der in der Gliederung von Balzert nicht auftaucht:
Produktinformation, d.h. Hersteller, Supportangebote, Möglichkeiten
zur Kontaktaufnahme mit dem Hersteller, Adressen, Telefonnummern, evtl.
Hinweise auf zu sätzliche Angebote wie Mailinglisten oder Newsforen.
-> richtig, wir werden wohl nur Name u. Anschrift
in den Dokumentations-Kopf aufnehmen.
-
Punkte, die entfallen können:
a) Installationsteil:
Der Teil "Installation" fällt bei uns weg, da wir ja ein Subsystem
des Produkts dokumentieren, dessen Installation auf einer höherliegenden
Ebene der Dokumentation beschrieben sein sollte.
Wenn mit der manuellen Justage gearbeitet wird, muss das Produkt bereits
installiert sein.
-> richtig, -> eigenes Installationshandbuch
b) Glossar:
Auf ein Glossar wurde aufgrund mangelnder physikalischer oder technischer
Fachbegriffe zum Gegenstand und zugunsten einer allgemeinen Einführung
in den Gegenstandsbereich verzichtet.
-> ???, andere Gruppe sehr gutes Glossar
c) Produktstruktur:
Aus denselben Gründen entfällt auch der Teil "Produktstruktur":
die Zusammenhänge zwischen dem Gesamtprodukt und dem hier behandelten
Teil sind mit einem Satz geklärt, so dass ein eigener Teil dafür
nicht nötig erscheint.
-> ???, dieser Meinung waren (fast) alle,
-> wird in unserem Benutzer-Leitfaden enthalten sein
d) Vorwort:
Da es sich bei der "Manuellen Justage" nur um ein Teilprogramm des großen
RTK-Steuerprogrammes handelt, haben wir auf die Kapitel "Vorwort", ...
verzichtet.
Da sowohl im Vorwort, als auch in der Einleitung der Adressatenkreis und
die Programm-Aufgabe beschrieben wird, haben wir diese beide Kapitel in
eine "Einleitung" zusammengefasst.
-> OK, wird in unseren Benutzer-Leitfaden übernommen
e) Benutzeroberfläche:
Produktstruktur/Benutzeroberfläche: Diese Punkte wurden
zum Punkt "Dialogfeld Manuelle Justage" zusammengefaßt.
-> ???, werden hier nur Banalitäten beschrieben?
-
Punkt ersetzen:
Das Literaturverzeichnis entfällt zugunsten des Teils Webadressen.
Dort Verweis auf die Seite des Projekts.
-> ginge dies nicht auch unter Literaturverzeichnis?
-> damit auch offen für Literatur
-
Anwendungsorientierter Teil:
Im Gegensatz zu Herrn Balzert wurde der Meinung Vorzug gegeben, dass o.g.
Teil aus Gründen der Übersichtlichkeit und eines (möglicherweise)
geringeren Interesses des Benutzers an Detailinformationen zugunsten einer
raschen Lösung des Problems möglichst einfach und leicht zu verstehen
sei (Arbeitsanleitung).
Die Detailinformationen könnten dann jeder Zeit im Referenzteil nachgelesen
werden.
-> wie ist dies gemeint?