berufliche Stationen

Seminar:  

So schreiben wir Software-Dokumentation normgerecht, verständlich, nachprüfbar

Referent: Dipl.-Ing. Wolfram W. Pichler, Berlin

Handbücher sind (auch rechtlich) Bestandteil eines jeden Software-Produkts. Für die Anwender sind sie der Schlüssel zum Produktnutzen. Wenn sie mit der Handbuch- und Online-Hilfe schnell und richtig ihre Arbeit erledigen können, sind sie mit dem Paket zufrieden und bleiben treue Kunden. Daher sind gut gemachte Software-Handbücher für die Hersteller eine unverzichtbare Stufe zum Markterfolg.

Die Strukturen von Software-Handbüchern sind in den meisten Fällen einander recht ähnlich. Diese Struktur einmal sorgfältig aufzubauen hilft, bei Folgeprojekten Arbeit, Zeit, Kosten und Nerven zu sparen. Wenn man einmal Corporate Design-Vorschriften, Redaktionsrichtlinien, Verfahrensanweisungen und Qualitätskriterien aufgestellt und eingeführt hat, kann künftig nicht mehr allzu viel schief gehen. Handbücher entstehen nach den Methoden des Projektmanagements wie jedes andere Projekt auch. Internationale ISO-Normen helfen dabei.

Seminarziel

Die Teilnehmer lernen Verfahren der Dokumentationsroutine kennen sowie Möglichkeiten, qualitativ einwandfreie Software-Handbücher zu erstellen und schließlich ihr Arbeitsergebnis im Hinblick auf Vollständigkeit, Orientierung und Anwender-Akzeptanz zu optimieren und zu bewerten.

Die vermittelten Inhalte werden anhand von praktischen Beispielen trainiert, so dass sie unmittelbar am Arbeitsplatz umgesetzt werden können.

Zielgruppen

Verfasser von Software-Handbüchern, die "nebenbei" schreiben müssen, obwohl sie dieses Kunsthandwerk nicht erlernt haben, sowie an (Quer-)Einsteiger.

Die Teilnehmerzahl ist begrenzt, um den Übungscharakter zu wahren. In den Übungen werden Beispiele aus der betrieblichen Praxis bearbeitet. Das Material dazu ist in den Teilnehmerunterlagen enthalten.

Die Zeit und die Kosten für dieses Seminar sind gut investiert. Denn die Mühe, die Sie als Arbeitsvorbereitung in Konzeption und Entwurf einspeisen, holen Sie im anschließenden Herstellungsprozess mehrfach wieder heraus. Sie werden am Ende Software-Handbücher erheblich effizienter produzieren und optimieren können.

Inhalt

1. Auftrag klären

Produkt-, Termin- und Verkaufsfakten – Benutzungsfreundlichkeit – Änderungsdienst – Übersetzen und Lokalisieren – Rechtsfragen – Kostenkalkulation – Kompetenzen

2. Planen und steuern

Personal und Verantwortlichkeiten – Ausstattung – Entwürfe – Kontrollen – Anwendertests – Freigabe – Wartung

3. Analysieren und entwerfen

Zielgruppenanalyse und -profile – Aufgabenanalyse und -profile – Informationen beschaffen – Dokumentationsumfang – Medien – Informationsprofile – Benutzungsfreundlichkeit – Dokumentations- und Dokumentenstruktur definieren – Redaktionsrichtlinien – Installationsanleitung, Tutorials, Kurz-Referenz – Diagramme, Charts, Screenshots, Programmcode-Darstellung

4. Entwickeln und kontrollieren

Entwürfe vorbereiten und herausgeben – Korrekturläufe – Druckvorlagen vorbereiten – Lokalisieren – Archivieren

5. Bewerten und aktualisieren

Produktbeobachtung – Update

6. Herstellen nach Redaktionsrichtlinie

Copyright- und Versionsangaben – Die Dokumentation im Überblick – Prozess- und Aufgabenbeschreibungen – Felder, Optionen, Namen, Objekte – Meldungen – Begriffsdefinitionen, Konzepte, fortgeschrittene Anwendung – FAQ – Online-Navigation – Online-Gestaltung

7. Online-Hilfe

System- und benutzerinitiierte Hilfe – Darstellung und Steuerung der Hilfe-Informationen – Kontextfreie Hilfe mit Suchmöglichkeit – Kontextsensitive Hilfe

8. Kalkulieren

Kosten komponenten – Top-down-Ansatz – Projektpreis – Nachkalkulation

9. Projekt-Checklisten nach ISO/IEC 18019 und DIN EN ISO 9241-13

 

10. Abschlussdiskussion

Seminar-Termine

Aktuelle Übersicht der Termine

- Änderungen  vorbehalten -

© 1996 pichler Berlin, zuletzt geändert 2006-08-11