Entwickler-Ecke

Off Topic - Dokumentationstool


Tino - Do 24.04.03 22:33
Titel: Dokumentationstool
Hallo Leute,

da ich mit meinem Projekt schon recht weit bin muss ich mir langsam aber sicher Gedanken über die Programmdokumentation machen.

Deshalb suche ich ein Programm mit dem ich Dokumentationen erstellen kann. Letztendlich möchte ich CHM und HTML (für die Online-Version) als Ergebnis bekommen. Da mein Programm Freeware ist möchte ich natürlich für so ein Dokumentaionstool auch nichts bezahlen. :-)

Hat jemand von Euch Erfahrungen mit solchen Programmen und kann mir einige nennen?

Danke schon mal!

Gruß
Tino


Motzi - Fr 25.04.03 08:03

Bin auch grad auf der Suche nach so einem Tool... ich hab gute Erfahrungen mit der Free-Version von HelpScribble gemacht, die Vollversion kostet allerdings...


mirage228 - Fr 25.04.03 08:11

Ich hab "HTML Help Workshop" hier, das könnte ich dir mal schicken...


Tino - Fr 25.04.03 09:02

mirage228 hat folgendes geschrieben:
Ich hab "HTML Help Workshop" hier, das könnte ich dir mal schicken...

Das habe ich auch. Alledings kann man mit diesem Tool ja "nur" aus HTML Dateien eine CHM Datei erstellen lassen. Ich würde aber gerne mit einem richtigen Dokumentationstool arbeiten. Wenn ich allerdings kein brauchbares finden sollte bleibt mir wahrscheinlich keine Wahl und ich erstelle jede einzelne HMTL Seite und benutze dann den HTML Help Workshop um eine CHM Datei zu erstellen.

Gruß
Tino


bis11 - Fr 25.04.03 11:43

Für die Programmhilfe nehme ich den HTML Workshop und zur eigenlichen Beschreibung (Anleitung) nutze ich Word und wandle dann das ganze um in ein PDF-Dokument.


Motzi - Fr 25.04.03 11:55

Schaut mal auf http://www.jgsoft.com/ - dort gibts das HelpScribble


Tino - Sa 26.04.03 13:02

Hallo Motzi,

danke für den Tipp. Ich hab mir das Programm mal angeschaut. Leider kostet eine Lizenz ein paar Euro.

Ich denke ich werde die HTML Seiten wohl einzeln und von Hand erstellen müssen und dann mit dem HTML Help Workshop zusammenführen lassen :cry: Was solls... ist dann halt ein wenig mehr Arbeit!

Gruß
Tino


Moritz M. - Sa 26.04.03 13:21

Es wäre doch auch mal eine Idee so ein Programm selber zu schreiben und mit Hilfe von dem HTML Help Workshop dann auch in's chm-Format zu kompillieren. So schwer stelle ich mir das nicht vor. Ein wenig Baumstruktur und fertig.


Tino - Mo 28.04.03 12:59

Hi,

Onz hat folgendes geschrieben:
So schwer stelle ich mir das nicht vor. Ein wenig Baumstruktur und fertig.

Schwer ist es bestimmt nicht. Allerdings müsste man auch einen vernüftigen Editor einbauen damit man nicht HTML Dateien selbst erstellen muss. CSS müsste unterstützt werden. Außerdem müsste es Funktionen geben um Links innerhalb des Hilfesystem einzufügen. Dann noch eine vernüftige Projektverwaltung und dann könnte die erste BETA rauskommen :-)

Gruß
Tino


tommie-lie - Mo 28.04.03 14:16

Was ich als Hinweis geben könnte ist, daß die GLScene-Doku mit einem Tool namens DocMaker erstellt wurde. Dazu sind Kommentare im Quellcode gleich mit HTML-Tags versehen (zum Beispiel <br>) und DocMaker macht nacher Unit- und Klassen-Orientiert eine CHM-Datei daraus. Aber ich weiß nicht, ob das Freeware ist und wie einfach es sich bedienen lässt, denn selbst benutzt habe ich den DocMaker noch nicht.