Erstellen einer Hilfe Dokumentation mit der Anwendersoftware DOC TO HELP 2000! (von S. Hufenreuter)

Nehmt den nachfolgenden Bericht als Anleitung und Hinweis für eine Erstellung einer selbst verfassten Hilfe. Wem ist das nicht schon so gegangen, die bestehende Hilfe zu einem tollen Programm ist irrsinnig, unverständlich und viel zu verschachtelt. Also, was liegt da näher, sich selbst eine verständliche Erklärung zum Programm zu erstellen.

Zunächst war für die Lösung meiner Praktikumsaufgabe eine Zeit von drei Monaten vorgesehen. Ich hatte die Hoffnung eher damit fertig zu werden, doch das sollte dann wohl nur ein Wunsch bleiben. Die Aufgabe bestand darin, eine 176 seitige Programm-Dokumentation über das Produkt V2 von der Dr. Stanja Solutions GmbH & CO.KG in eine Windows-Hilfe umzuwandeln.

Erster Schock = das Programmpaket DOC TO HELP, wie auch die Anleitung zum Programm sind komplett in Englisch verfasst. Nunmehr gibt es zwar eine kleine Erklärung in Deutsch, aber die reicht bei weitem nicht aus das Programm zu erkennen. Die Hauptschwierigkeit bestand eigentlich darin, das es zu Kompatibilitätsproblemen, Formatproblemen und sprachbedingten Fehlern nichts informatives zu finden gab und glaubt mir, es ist mühselig in einem englischen Buch eine Erklärung zu finden. Wie sich gezeigt hat, nützen da auch die im Programm enthaltenen Dokument-Diagnostics und Fehlerauswertungen wenig, wenn die Fehlermeldungen nach angestrengter Übersetzung einfach keinen Sinn ergeben.

Das Programm an sich ist recht umfangreich, läuft optimal unter Win 9x/NT/2000, ist für Word 95/97/2000 abgestimmt und hat eine Menge nützlicher Arbeitstools, wie AnswerWorks 3.0, Microsoft HTML Help, Workshop 1.2 usw. Auf die Tools werde ich nicht eingehen. Die Funtionsweise" Erstellung einer Hilfe" findet ihr unter Präsentation.

Ihr müsst euch nicht gleich entscheiden ob Ihr eine Single- oder eine Multiple Struktur haben wollt. Man kann durchaus eine Single Struktur in eine Multiple Struktur wandeln, umgekehrten Wandel hab ich noch nicht ausgekundschaftet (beide Strukturen sind erklärt in der Präsentation). Es ist gleich, ob ihr schon vorhandenen Text übernehmen wollt oder direkt schreibt, aber hier einige " Hinweise" :
Bei Übernahme von bestehendem Text, bitte zuvor alle vorhandenden Textmarken (die findet ihr im Word über Einfügen / Textmarken) löschen. Links und andere bestehende Verweise ebenfalls entfernen (am besten unter Extras / Optionen alle Funktionen und auch Feldlinien anhaken), dann seht ihr die Formatfunktionen im Dokument und könnt sie löschen. Vermeidet Umlaute in der Überschriftenkategorie 1(was das ist, erfahrt ihr unter Präsentation).
Formatiert Textbestandteile nach Doc To Help Vorgabe, so umgeht ihr Konflikte.
Grafiken und Fotos lassen sich leicht und problemlos über die Embeddet Funktion, unter Menü / Einfügen, einbinden. Einmal eingefügt, übernimmt das Programm das Objekt im Kompiliervorgang in einen eigens dafür erstellten Bitmapordner.
Jedoch haben die Bilder nach dem Einbinden keine eigene Bezeichnung mehr und sind so schlecht wiederzuerkennen. Wenn auch noch sehr viele Objekte eingebunden werden sollen und eine Kontrolle gewünscht ist, verwendet die zweite Variante der Einbindung. Die Objekte werden in einen separaten Ordner zur Verfügung gestellt und mit einer Pfadfunktion eingebunden. Siehe Beispiel : {INCLUDEPICTURE "C:\\Ordner\\Unterordner\\Bild.bmp" \* MERGEFORMAT \c }.

Für das fertige Ergebnis einer Hilfe bieten sich einige Varianten an. Am sinnvollsten ist wohl die Windows-Hilfe (*.hlp) oder die HTML compiled (*.chm). Die HTML Version ist wohl die am besten gestaltete Hilfe, jedoch bietet die Windows-Hilfe eine sehr schöne Popup Struktur.

Nun alles in allem ist eine fertige, fehlerfreie und verständliche Hilfe ein guter Assistent zur Lösung von Anwenderaufgaben. Leider hat die zur Verfügung stehende Zeit nicht ausgereicht, eine inhaltliche Neugestaltung der vorhandenen Dokumentation durchzuführen. Aber das erzielte Ergebnis entschädigt die wochenlange Quälerei mit den so genannten "Unbekannten".

P.S. die Präsentation folgt in Kürze !