PDA

Archiv verlassen und diese Seite im Standarddesign anzeigen : Tools für Dokumentation?


oracle2025
02-05-2004, 17:30
Hi,
welche Systeme verwendet ihr denn so, wenn ihr User-Dokumentation erstellen wollt?

Ich bin so auf der Suche nach nem einfach zu bedienenden Editor, ein Format, bei dem man auch Screenshots einbinden kann, und das halt am Ende ne freundliche HTML Doku herauskommt. Wär auch praktisch, wenn's irgendwie verschiedene Ausgabeformate unterstützen würde.

So ähnlich wie das hier, aber nach Möglichkeit OpenSource:

http://www.helpblocks.com/

habt ihr irgendwelche Vorschläge, Ideen?
Boron
02-05-2004, 17:38
Da in KDE das Standardformat für Programmdokumentation/Hilfe HTML ist tut es jeder Editor. Komfortabler mit Quanta.

Irgendwelche speziellen Programme um Doku/Hilfe zu erstellen wäre mir jetzt nicht bekannt.
axeljaeger
02-05-2004, 19:10
Wenn du auch API-Dokumentation machen willst, wirst du um Doxygen nicht herumkommen. Ganz nett um HTML-Dateien anzuzeigen ist der Qt Assistant. Da kannst du auch links einen Treeview und eine Suche bekommen.
peschmae
03-05-2004, 07:48
Ich würde Docbook verwenden.

Das macht nämlich KDE genauso :)
http://developer.kde.org/documentation/tutorials/howto/documentation.html

Daraus lässt sich dann diverses generieren:
HTML, PDF, Postscript aber auch RTF, Text, Latex (je nach dem was für einen Prozessor man verwendet)

MfG Peschmä
oracle2025
03-05-2004, 10:49
Ich hab tatsächlich mal einen vielversprechenden docbook editor gefunden:

http://www.conglomerate.org/

Jetzt noch mal ne Frage, kann man png-Bilder in docbook verwenden?
anda_skoa
03-05-2004, 11:09
Davon würde ich mal ausgehen, PNG ist schliesslich das Standardformat für verlusstfreie Kompression.

Ciao,
_
peschmae
03-05-2004, 18:41
Ja, PNG geht.

Kommt natürlich auf immer auf den Prozessor an - aber bisher liefs bei mir mit allen.

MfG Peschmä
Maledictus
04-05-2004, 08:50
gibt es sowas wie conglomerate auch für KDE?
peschmae
04-05-2004, 12:59
Quanta eventuell, da kann man afaik DTDs laden - aber über die Features weiss ich nicht so bescheid.

Was spricht gegen Gtk? Ich meine - du kannst es auch unter KDE benutzen (und es sieht erst recht noch seröser aus *duck*)
Ein Argument gegen das Teil ist allerdings, dass das Teil nicht frei ist - das liesse ich gelten ;)

MfG Peschmä
Maledictus
04-05-2004, 21:52
für kate gibts wohl so ne art docbook plugin, vielleicht probier ich das mal.

das es nicht frei ist, ist ein K.O. Kritierum.

ich habe diverse GTK Bibliotheken installiert, aber ich benutze sie nur wenn es sich nicht vermeiden lässt.
aber ich will jetzt hier keinen toolkit krieg anzetteln :)