dokumentationsframework

hi
wir benutzern momentan in der firma maven, sind aber nicht so ganz zufrieden damit. Daher wollt ich euch mal fragen, ob ihr dokumentationsframeworke kennt und empfehlen könnt.

rauskommen soll im endeffekt dann html files (automatisch generiert) und pdf / rtf / doc

mit maven funktioniert die html erstellung recht gut, die book erstellung (rtf / pdf) aber gar nicht wirklich gut.

any tipps? was verwendet ihr?

naja das wird nicht mit code generiert.
im grunde wird sowas wie eine online dokumentation geschrieben. ohne code. nur codesnippets eben herausgefasst.
sowas du du es eben bei der svn dokumentation zb findest

keines von beiden. ich will keinen code dokumentieren, sondern benutzerhandbücher erstellen.
das ganze sieht momentan so aus: apt (almost plain text) files werden per hand geschrieben. da steht zb drinnen (in klartext mit apt konformen befehlen)

The Basic Installation and Setup Guide shows how to set up a Server instance, basicly a demo server with database connection. It gives introduction to the content structure, the Server uses, to manage its content and you can see how the structure of the content is configured with an Interface




    * Introduction


      This section gives a general introduction to the Platform , without going too much into detail. 




    * Server


      Get to know the basics of the Server. With this documentation you should be able to set up a demo server with database connection and to edit the most important and most used parameters in the configuration files. This section also discusses the content structure, used by the server to manage its content.


    *  Win Client


      Currently there exist three Clients for users to connect to a Server and to work on the content managed by the server. The most important one is the Windows Client.


      There also exists a Web - Client .


      This section describes how to install the Windows Client because it is part of a basic installation.




    * Overview of Videos


      This section gives an overview of all video tutorials regarding Basic Installation of the Platform. There are other video tutorials at appropriate sections of the documentation, have a look at them

so, das hat nun gaaaar nichts mit code zu tun, das ist einfach eine technische dokumentation über diese plattform.
momentan wird eben maven verwendet (link). was raus kommt ist eine fette htmlseite (pro file wird eine eigene htmlseite generiert) - das ist auch gut so. aaaaaaber nun kann das framework auch pdf && rtfs erstellen mit eben diesen apt files. nur spielt das eben nicht besonders gut mit den links zusammen. die links für die htmlseiten werden online verwaltet auf einem sftp server. (benutzername + kennwort erforderlich, um die doku überhaupt anschaun zu können)

maven checkt aber nicht, dass man dafür bn+pwd braucht, daher musst ich die ressourcen immer lokal speichern, dazu musste ich aber eben jeden einzelnen link der images verändern (das sind schon so um die 500).

nun hab ich mir gedacht: ich schreib mir einen apt to latex converter, damit ich mit latex eben dieses pdf erstellen kann (und nebenbei siehts auch gleich so aus wie ich will, denn das rtf das bei maven rauskommt, muss man auch noch seinen wünschen entsprechend formatieren).

bevor ich das aber mache, wollte ich grundsätzlich wissen, ob ihr irgendwelche dokuframeworks kennt, mit denen man eben in textform doku schaffen kann, die wird dann in html generiert und andererseits auch als pdf generiert, damit man möglichst wenig aufwand hat.

ziel ist es die doku sowohl online (mit videos, images usw) zu haben wie auch offline in einem benutzerhandbuch.

(ich könnt das ganze natürlich auch in word schreiben, denn word kann ja auch html files generieren... aber vorher erschieß ich mich).

ich hoffe das war jetzt etwas klarer - tut mir leid, wenn das vorher so schwammig war.

Zitat von Kampi

also zumindest ich werde noch immer nicht ganz schlau aus dem was du schreibst/willst. wenn es nun eh einfach text ist, dann verwende doch latex. das erzeugt dir pdfs und grausliches html.

ja das wäre eben meine idee gewesen und mein nächster schritt, aber ich wollte eben wissen, obs noch andere sachen auch gibt, die ich mir anschaun kann. ich kann ja nicht hingehn zum boss und sagen: wir verwenden jetz latex, have fun. ich sollte schon sagen können: ich hab mir das und das angesehen, das schaut nicht gut aus, daher nehmen wir latex, weil damit kenn ich mich aus und es produziert grausige html files, die man eh mit css hübsch machen kann ..
die entscheidung ist eben noch nicht gefallen (weder von mir noch von ihm) und daher wollt ich infos sammeln.
dazu kommt, dass ich noch keinen tex2html konverter benutzt habe, muss ich noch machen, um mir den tatsächlich brauchbaren nutzen von den mistigen htmlfiles anzusehen

die 2 vorgeschlagenen docbook und texinfo gehen schon in diese richtung - danke!