Handbuch erstellen

Hallo,

für ein umfangreiches Programm soll ein Handbuch erstellt werden. Welche Möglichkeiten hat man, wenn man den gleichen Text auch als Windows-Helpfile haben möchten und auch evtl. noch im HTML-Format.

Word kommt für ein solches Projekt ja wohl nicht in Frage, da es sich hierbei um ein Dokument mit mehreren hundert Seiten, die teilweise auch noch Screenshots enthalten werden.

Welche Vorschläge könnt ihr mir machen?

Björn Puls
http://www.tapu.de

Hallo Björn

Meine Frau arbeitet in dem Bereich technische Dokumentation professionell. Da die Mitarbeiter in Ihrer Firma mit MS Office arbeiten, muß sie Word als Master einsetzen.

Um daraus dann eine Online Hilfe und HTML zu erstellen, benutzt Sie das Programm DocToHelp. Das ist durchaus teuer und nicht unproblematisch, aber funktioniert.

In neuerer Zeit ist Sie auch dazu übergegangen, das PDF-Format zu verwenden, aber der dazugehörige PDF-Writer ist ziemlich teuer.

Falls Du nähere technische Einzelheiten wissen willst, dann schick mir ne Mail, meine Frau wird sie dann beantworten.

Viele Grüße
Thomas

dann mal viel Spaß :smile:
Tach Björn :smile:

für ein umfangreiches Programm soll ein
Handbuch erstellt werden. Welche
Möglichkeiten hat man, wenn man den
gleichen Text auch als Windows-Helpfile
haben möchten und auch evtl. noch im
HTML-Format.

Tja, da weiß ich nicht so ganz genau, wie professionell Du die Sache erstellen willst/mußt und welchen Umfang das ganze haben soll.
Als Autor arbeite ich mit unterschiedlichen Vorlagen für Textverarbetungsprogramme die dann vom Satz entsprechend eingearbeitet werden. In diesme Fall wäre Word also nur die Oberfläche zum Erstellen der Texte in der richtigen Reihenfolge und mit den entsprechenden Objekten zwischen den Textbausteinen.
Eine Windows-Hilfedatei ist natürlich ein richtig fettes Unterfangen. Ich bezweifle mal aus schrifstellerischer Sicht, daß sich die Handbuchtexte so einfach auf die Hilfedatei übertragen lassen. Allgemein benutzt man dafür knackigere Formulierungen und prägnantere Anweisungen (klicken Sie, setzen Sie etc).

Word kommt für ein solches Projekt ja wohl
nicht in Frage, da es sich hierbei um ein
Dokument mit mehreren hundert Seiten, die
teilweise auch noch Screenshots enthalten
werden.

Grundsätzlich schließe ich mich der Empfehlung von StarOffice an. Der HTML-Export ist recht ausgereift. Allerdings schon mit sehr eingschränkten Layoutmöglichkeiten. Wenn Du mit den Maßstäben rangehst, mit denen Du Deine Page erstellt hast, wirst Du für die Anpassung der Seiten wohl nicht viel weniger Zeit in investieren müssen, wie für eine komplette Neuerstellung in HTML. Bei der Arbeit mit StarOffice für den HTML-Export kommt es darauf an, wie lange Du braucht, Deine eigenen Objekte und Seitenstruktur als Katalogsystem aufzubauen. Das solltest Du Dir besser selber anschauen.

Hast Du in diesem Zusammenhang eigentlich mal daran gedacht, das Handbuch als PDF-Datei aufzubauen? In diesem Fall könntest Du sogar in Word arbeiten und dann das fertige Dokument exportieren. Mit einem netten Navigations-frame auf der linken Seite und einem nernünftigen Register hast Du Dir die Arbeit der Hilfedatei auch gleich erspart.

Viel Spaß
Lars :smile:

Ich arbeite zu Hause noch mit Staroffice 4.0 und bin damit zufrieden.

Das Ausleiten nach HTML ist kein Problem.

Wie das mit den Hilfe-Dateien Aussieht weiß ich nicht.

Dazu habe ich folgende Links gefunden, wo Du einmal weiterschauen kannst:

http://www.teamstaroffice.org/
Mail:
[email protected]

Ansonsten habe ich noch die Seite von Werner Roth gefunden, wo auch einige Probleme beleuchtet werden:
http://www.wernerroth.de/staroffice/

Ich hoffe das Hilft Dir weiter.

Auf jeden Fall empfehle ich Dir, um das Dokument klein zu halten, daß Du die Graphiken nur als Verknüpfung außerhalb des Dokumentes behälst.

Schön Abend und viel Glück, und, wenn Du was erfolgreiches gefunden hast, dann laß es uns hier wissen.

Gruß

Winni

[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]

Hi Björn,

versuch mal Staroffice dazu. Ich hab’s zwar selber nicht getestet, aber mir wurde mehrfach erzählt, daß man damit auch ganz super HTML Seiten erstellen kann.

Gruß, Heike
htp://come.to/heike

[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]

Wer braucht heute noch ein Helpfile?
Hallo.

Ich würde die Datei direkt in HTML schreiben. So können Bilder und andere Medien direkt eingebunden werden und die Links sind einfach realisierbar. Wenn du’s einfach haben willst kannst du z.B. den Netscape Composer benutzen, um die Seiten zu erstellen.

Ein Helpfile würde ich garnicht mehr schreiben.

  1. Jedes Betriebssystem kann HTML-Dateien anzeigen.
  2. Mittlerweile kann aus allen gängigen Programmiersprachen direkt eine HTML-Seite bzw. eine Sprungmarke in einer HTML-Seite angegeben werden. Es können somit jede beliebigen Suchfunktionen oder Auswahlkriterien in der Programmiersprache geschrieben werden.

Ralph