Dokumentversion: 1.0 (08.02.2001)
Autor: Erstautor:
U.Sacklowski
Zustand:in Bearbeitung
Diese Dokumentation ist bei Bedarf/Erkenntnis durch die Projektmitglieder fortzuschreiben (mit Autorenhinweis).
Änderungen:
- 12.02.00, Sacklowski
Szenarium -> Gesamtvorgang
- 14.03.00, Sacklowski
Ergänzung um die Sprachregelung 'dt. / engl.'
-> Anhang
Gliederung
1. Gliederung: Benutzer-Leitfaden für einen Gesamtvorgang
2. Benutzer-Leitfaden für einen Gesamtvorgang im Detail
2.1 Dokumenten-Kopf
2.2 Inhaltsverzeichnis
2.3 Einführung
2.4 Überblick über den Gesamtvorgang
2.5 Feinablauf des Gesamtvorganges
2.6 Literaturverzeichnis und Web-Adressen
2.7 Glossar
2.8 Register
Anhang
Dialog- und Meßfenster
in englisch
1. Gliederung: Benutzer-Leitfaden für einen Gesamtvorgang
Der Begriff des Gesamtvorganges wurde in dem Dokument 'X. Benutzer-Handbücher,
Hinweise zu den Benutzer-Handbüchern, Welche
Benutzer-Handbücher' im Pkt. 5.1 eingeführt und an Hand von
Beispielen erläutert.
Gliederung für einen Benutzer-Leitfaden für einen Gesamtvorgang:
Dokumenten-Kopf
Inhaltsverzeichnis
1. Einführung
2. Überblick über den Gesamtvorgang
(z.B. Überblick über den Topographie-Gesamtvorgang)
3. Feinablauf des Gesamtvorganges
(z.B. Feinablauf des Topographie-Gesamtvorganges)
4. Literaturverzeichnis und Web-Adressen
5. Glossar
6. Register
Die beiden Hauptpunkte 2 und 3 können (so weit vorhanden) aus den Dokumenten zu den Gesamtvorgängen aus den Entwicklerlerdokumenten übernommen werden.
Dort zur Topographie: IX. Entwicklerdokumente, Analyse und
Definition, Topographie, Gesamtvorgang
Dort zur Diffraktometrie/Reflektometrie: IX. Entwicklerdokumente,
Analyse und Definition, Diffraktometrie/Reflektometrie, Gesamtvorgang
2. Benutzer-Leitfaden für einen Gesamtvorgang im Detail
Bsp. für den
Topographie-Gesamtvorgang (.html)
Vorgegebene Gliederung in Pkt. 1
- Erläuterung zum Aufbau und dem Umgang mit dem Benutzer-Leitfaden,
- damit eine Art Gebrauchsanleitung.
- Adressatenkreis (Studenten im Praktikum, techn. und wiss.
Mitarbeiter)
- Einbettung in Gesamtheit der Benutzer-Handbücher.
Z.B. beim ' Topographie-Gesamtvorgang' hinweisen auf die Dokumente der
Basisanwendungen, die Bestandteil des Gesamtvorganges sind.
2.4 und 2.5
Überblick
über den Gesamtvorgang (z.B. Überblick über
den Topographie-Gesamtvorgang)
Feinablauf
des Gesamtvorganges (z.B. Feinablauf des Topographie-Gesamtvorganges)
Allgemeine Bemerkungen zum Gesamtvorgang:
Der Gesamtvorgang wird in Teilvorgänge gegliedert. Ihrer Realisierung
dienen:
- Manuelle Aufgaben, d.h. Aufgaben ohne Unterstützung des XCTL-Steuerprogrammes
(z.B. handschriftlicher Eintrag in das Protokollbuch),
- Dialog-Aufgaben, d.h. Aufgaben mit Unterstützung des XCTL-Steuerprogrammes
(z.B. bei der manuellen Justage, wo sich Eingaben in eine Dialogbox durch
den Nutzer mit der durch das XCTL-Steuerprogramm gesteuerten Regelung abwechseln
oder im Zählerfenster die Anzeige der aktuellen Zählraten).
Dialogaufgaben werden durch Basisanwendungen des XCTL-Steuerprogrammes realisiert.
Die Beschreibung des Feinablaufes erfolgt verbal, - im Falle von Dialogaufgaben
mit den entsprechenden Dialogboxen und Dialogfenstern.
Deutsche oder englische Dialog- und Meß-Fenster?
Eine gute Vorlage/Orientierung für die Punkte 2.4 und 2.5 bietet der im Pkt. 1 erwähnte Gesamtvorgang zur Topographie.
Der dortige Pkt.1 'Einleitung: Fachlicher Hintergrund, Ziel und Grobablauf
des Topographie-Gesamtvorganges' wird hier Pkt. 2.4.
Der dortige Pkt. 2.4 'Feinablauf des Topographie-Gesamtvorganges,
Verbale Beschreibung, wird hier Pkt. 2.5.
2.6 Literaturverzeichnis und Web-Adressen
Begriffsdefinitionen, Abkürzungen, Einheiten
Stichwortverzeichnis
Anhang
Dialog- und Meßfenster
in englisch
Hier werden nur die Fenster ohne Beschreibung der Felder dokumentiert. Deutsche oder englische Dialog- und Meß-Fenster?