3. End-User Dokumentation schreiben

End-User Dokumentation schreiben

  • S

    Hallo Leute!

    Mit welchen Tools schreibt ihr Enduser Dokumentationen?
    Bisher habe ich dafür Word verwendet - was auch super geht, mit den ganzen Formatdefinitionen, so dass man das Design auch recht leicht anpassen kann.

    Doch es gibt keinen vernünftigen Export nach PDF und HTML (das Word HTML ist ja pervers).

    Für mich sind eben Export nach PDF und HTML recht wichtig (nach CHM wäre es auch nett, muss aber nicht sein). Weiters will ich ähnlich wie in Word Formatvorlagen definieren können - so dass ich Text und Design ordentlich trennen kann (automatisches Table Of Contents erstellen ist auch ein muss). Man muss auch Hyperlinks (intern und extern) in das Dokument einbauen können.

    Natürlich habe ich mir OpenOffice angesehen - das ist soweit auch in Ordnung, ich frage mich halt nur, ob es nicht etwas besseres gibt, denn so ganz glücklich bin ich mit OOo auch nicht 😞

    0
  • T

    Da empfehle TeX bzw LaTeX. Durch die hohe Verbreitung gibt es zahllose Tools um TeX Dateien in irgendein Zielformat zu konvertieren. PDF und HTML ist dabei.. CHM geht damit sicher auch.

    0
  • W

    Also ich glaube nicht, dass du dafür was besseres als OOo oder Word (+ geeignetes HTML-Cleanerprogramm) findest. Latex finde ich für eine Enduserdoku einfach zu unproduktiv, aber sieht natürlich professioneller aus. Wenn du gutes HTML willst dann könnte ich dir noch vorschlagen einfach die Doku in HTML zu verfassen und dann die Konvertierung in PDF über Acrobat o.ä. vorzunehmen 😉 .

    0
  • S
    Mod

    HTML hat als einziges hier Portierungen für alle genannten Formate - dafür plagst du dich aber auch ganz schön bei der Erstellung. WYSIWYG-Editoren hasst du ja wie die Pest 🙂

    Das Word nicht nach *.chm konvertierbar ist kann ich mir nicht vorstellen, kommt doch beides aus dem Hause Microsoft oder?

    Ansonsten: http://www.latex-project.org/

    MfG SideWinder

    0
  • H

    Hi!

    Openoffice ist auch sehr leistungsstark und einfach zu bedienen (habe meine Facharbeit damit geschrieben), und der Exporter nach PDF ist einfach nur perfekt 🙂

    Bei Druckern unter Linux kann man als Output einen PDF Filter setzen, http://cip.physik.uni-wuerzburg.de/~vrbehr/cups-pdf/ als das Beste was mir ein esearch pdf -s geliefert hat.

    Ich hoffe das hilft dir 🙂

    0
  • S
    Mod

    Gibts natürlich auch für *.doc:
    free: http://www.pdfconverter.com/
    prof: http://www.8848soft.com/doc2pdf/

    MfG SideWinder

    0
  • W

    Gibts auch frei: http://sourceforge.net/projects/pdfcreator/

    0
  • M
    Mod

    Word nach CHM sollte über den Windows-Help-Compiler gehen (via Export nach RTF).

    0
  • P

    @Shade:

    - Word + Acrobat Destiller
    - MS Visio
    - XML Suite (Spy XML u.m)
    - DOORS/ERS
    - Rational Rose
    - Clear Case
    - Excel
    - API Docs
    - Crystal Reports
    - Business Objects

    End-User ggf. auch Entwickler, der meine Komponenten implementieren muss.

    0
  • S

    Danke euch allen! Ich werde bei Word bleiben - denn OOo hat es nicht geschafft Fehlerfrei nach HTML zu exportieren (PDF funktioniert dagegen recht gut, auch wenn ich interne Links nicht zum laufen gebracht habe).

    @Prof84:
    he he, danke - aber soviel Geld habe ich nun auch wieder nicht (ich will ja nicht für das Schreiben der Dokumentation mehr ausgeben als für die Entwicklung der Software ;))

    0
  • P

    Shade Of Mine schrieb:

    @Prof84:
    he he, danke - aber soviel Geld habe ich nun auch wieder nicht (ich will ja nicht für das Schreiben der Dokumentation mehr ausgeben als für die Entwicklung der Software ;))

    Ach, sind doch echte Schnäppchen 😃 :

    - Word + Acrobat Destiller ca. 400,- € incl. Märchen
    - MS Visio EA ca. 800,- € incl. Märchen
    - XML Suite (Spy XML u.m) ca. 1.300,- $ incl. Märchen
    - DOORS/ERS FL ca 6.850,- € zzgl. Support u. Märchen
    - Rational Rose Enterprise LL ca. 4.900,- € zzgl. Support u. Märchen
    - Clear Case FL ca. 1.900,- € zzgl Suport u. Märchen
    - Excel ca. 400,- € incl. Märchen
    - API Docs für lau
    - Crystal Reports Enterprise LL ca. 2.500,- € incl. Märchen

    Das Paradoxe ist: Die Tools rechnen sich! Gerade RR und DOORS/ERS hauen tierisch rein. Aber -

    1. degradieren sie meine Auftraggeber, die solche "Ausdrucksformen" niemals von der Hand hinbekommen oder auch nur kennen.
    2. kann ich dreifache Rechnungsstunden stellen und bekomme trotzdem ein "Mann, sind sie wieder schnell gewesen!" zu hören 😃 .
    3. ist alles präzise abgestimmt => hohe Kundenzufriedenheit => Folgeprojektauftrag wird wieder bei mir gebucht.
    4. irgendwann wollen sie dann "Zauberlehrling" werden und dann lange ich ganz fürchterlich zu ... 🕶

    Mal abgesehen davon schmerzen die nach Steuer nur halb ... 😉

    cu

    P84

    0
  • O

    Rational Rose Enterprise LL ca. 4.900,- € zzgl. Support u. Märchen

    krass 😮

    0
  • T

    Im Hinblick auf ein anstehendes Studium wäre es strategisch 🙂 besser LaTeX zu erlenen, auch wenn der Aufwand anfangs groß erscheint.

    0
  • W

    TheMummy schrieb:

    Im Hinblick auf ein anstehendes Studium wäre es strategisch 🙂 besser LaTeX zu erlenen...

    Also ich kenne Leute die auch wunderbar ohne ausgekommen sind. Für mich ist es ziemlich praktisch, wenn man sich mal eine zusammenfassende Formelsammlung fürs Semester erstellt, oder wenn man Aufgaben abgeben muss (sieht besser aus), aber ich möchte OOo trotzdem nicht missen, wenn man mal schnell etwas schreiben muss. Für eine Enduser-Doku halte ich es nach wie vor nicht geeignet. Die Stärken von LaTeX liegen in der Verfassung wissenschaftlicher Texte, denn wenn man viele Formeln pro Seite braucht nervt so ein Klickibunti-Editor - wie der von Word o.ä. - gewaltig.

    TheMummy schrieb:

    ...auch wenn der Aufwand anfangs groß erscheint.

    Scheint aber nur so. Ich konnte bereits nach dem ersten Tag 80% der Sachen die ich heute so brauche. Den Rest schaut man sich dann bei Bedarf kurz irgendwo an. Gut ist auch das Latex Cheat Sheet für den Einstieg.

    0
Anmelden zum Antworten