SGML, die Basis für eine optimierte Produktion von

Windows-Online-HilfenThomas Bergerhoff,Tanner Dokuments

Nürnberg

OnlineForum ´99

22SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Wer ist die DATEV?einer der größten Informationsdienstleister und

Softwarehäuser in Deutschland und Europabisher einzige berufsständische EDV-Dienstleistungs-

organisation für den steuerlichen Berater in EuropaUmfangreiche Software-Palette mit über 100

ProgrammenService in Bereichen wie Organisationsberatung,

Kanzleischulung, Support zum DV-Einsatz u. a.Datenverarbeitung über ein leistungsstarkes

Rechenzentrumca 4800 Mitarbeiter

OnlineForum ´99

33SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Das Dilemma

Fachabteilung:Programmierer entwickeln die SoftwareRedakteure schreiben die Online-Hilfen

mal 100 =

100 Online-Hilfen,alle mit einem unterschiedlichen Aussehen

OnlineForum ´99

44SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Zentrale Koordinierung der Redakteure

Online-RedaktionRedakteur inFachabteilung 6

Redakteur inFachabteilung 1

Redakteur inFachabteilung 3

Redakteur inFachabteilung 4

Redakteur inFachabteilung 5

Redakteur inFachabteilung 2

OnlineForum ´99

55SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Die Ziele

Standardisierte und in einem hohen Maß automatisierte Produktion der Online-Hilfen

Gut strukturierte und verständliche Online-HilfenEinmal erfasste Informationen sollen für weitere Zwecke

(z. B. Intranet) wiederverwendet werden können

OnlineForum ´99

66SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Der WegKlassifizierung der in den Online-Hilfen

enthaltenen InformationenInhalts- und Strukturplanung für die ermittelten

Informationsklassen der Online-HilfenEinführung einer verbindlichen Schreib-, bzw.

Formulierungstechnik für alle beteiligten RedakteureEinsatz geeigneter Werkzeuge, die gewährleisten, daß

die Vorgaben eingehalten werden

Zentrale Online-Hilfe-Produktion

OnlineForum ´99

77SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Die MittelSGML als Basis für die Inhalts- und

Strukturplanung der klassifizierten InformationenFunktionsdesign als Schreibtechnik, die in die SGML-Struktur

integriert ist und gleichzeitig den Redakteuren als Regelwerk beim Verfassen der Online-Hilfen zur Verfügung steht

OnlineForum ´99

88SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Definition der Informationsklassen

HilfetafeltypenProgrammbeschreibu

ngFensterbeschreibungVorgehenDirekthilfePopupFehlermeldungFachhilfeAuslagerungstafel

bechreibt Programmbeschreibt Dialogfensterleitet zum Handeln aninformiert über Dialogelementegibt kurze Zusatzinformationleitet zur Problemlösung aninformiert fachlich gibt längere

Zusatzinformationen

OnlineForum ´99

99SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Was ist SGML?SGML heißt Standard Generalized Markup

LanguageWeltweit verbreiteter ISO-StandardAuszeichnungs-Sprache zur Definition von

Struktur und Inhalt von DokumentenDefinition wird in der Document Type

Definition (DTD) getroffenLayout wird in einem nachgelagerten Prozeß je

nach Anforderung dazugefügtTrennung von Struktur und Layout ist Basis für ein

zeitloses und beliebig austauschbares Datenformat

OnlineForum ´99

1010SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Integration der Hilfetafeltypen in die DTD

OnlineForum ´99

1111SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Die DTD ist eine hierarchisch geschachtelte Struktur

Erfassungsebene, Funktionsdesign

OnlineForum ´99

1212SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Was ist das Funktionsdesign?Strukturierungs- und Schreibtechnik für die

effiziente Erstellung von konsistenten und anwenderfreundlichen Dokumentationen

jede kommunikative Absicht des Verfassers entspricht einer funktionalen Text-Einheit

Beispiele für funktionale Text-Einheiten:Überschrift, Signaleinheiten, Handlungssequenz

Strukturierung der funktionalen Text-Einheiten auf der Erfassungsebene der DTD

steht den Redakteuren als Regelwerk im Redaktionsleitfaden zur Verfügung

OnlineForum ´99

1313SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Wo steckt das Funktionsdesign in der Online-Hilfe?

Zielangabe

Handlungsaufforderung mit integrierterBedingung

Handlungs-aufforderung

Resultatsangabe

OnlineForum ´99

1414SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Welche Werkzeuge werden eingesetzt?

Erfassen: FrameMaker + SGML

Konvertieren: Hilfeproduktionsassistent

Produzieren: Microsoft Help Workshop

.sgm

.Cnt, .hpj, .rtf

.hlp

OnlineForum ´99

1515SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Erfassen der Online-Hilfen mit Framemaker+SGMLDreigeteilter Arbeitsbereich in Framemaker+SGML:

Hilfetexte erfassen

Elementeauswählen

In der Struktur navigieren

OnlineForum ´99

1616SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Zentrale Konvertierung der SGML-Dateien mit dem Assistenten für die Hilfeproduktion

Hilfeproduktionsassistent

Omnimark-Filter

Workstation

Server

ruft Omnimark-Filter auf

konvertiert die SGML-Dateien

OnlineForum ´99

1717SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Zentrale Konvertierung der SGML-Dateien mit dem Assistenten für die Hilfeproduktion

OnlineForum ´99

1818SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Zentrale Konvertierung der SGML-Dateien mit dem Assistenten für die Hilfeproduktion

OnlineForum ´99

1919SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Ergebnis der Konvertierung

Quelldateien für die Hilfeproduktion

OnlineForum ´99

2020SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Produktion der Online-Hilfe aus den Quelldateien

OnlineForum ´99

2121SGML, die Basis für eine optimierte Produktion von Windows-Online-Hilfen

Ausblick

Der Einsatz von SGML in Verbindung mit dem Funktionsdesign führt zu strukturierten, konsistenten und verständlichen Online-Hilfen

Durch den Workflow wird ein hohes Maß an automatisierter Produktion realisiert

Es sind noch lange nicht alle Möglichkeiten ausgeschöpft, die SGML bietet:Der zusätzliche Einsatz einer SGML-basierten Datenbank bietet weitere entscheidende Vorteile wie eine maximale Wiederverwendung von Informationen