Software um Dokumentation zu erstellen

[Xcalibur]

hy...

mach hier grade mein vorpraktikum in nem software-unternehmen und hab die aufgabe bekommen, mir mal die doku zu ner software anzusehn und diese zu verbessern.
die besteht bisher aus einer navigation in html und darin verknüpfte Word-Dokumente.
Nicht wirklich ne schöne Lösung und man hat keine Versionskontrolle (was wann verändert wurde).
Ziele sind eben diese Versionskontrolle und einfache Bearbeitung (wird ständig weiterentwickelt)

Mein erster Ansatz war alles in ner Art Wikipedia-Datenbank zu machen, aber da besteht das Problem, dass mir noch kein geeigneter Word2Wiki-Konverter unter die Augen gekommen ist und das ist einfach ein muss bei mehreren hundert seiten.

Man könnte alles in Doc-Dokumenten bearbeiten, dann jeden morgen automatisch ne html-version fürs intranet und bei auslieferung an kunden ne pdf abziehn, fehlt aber wieder die versionskontrolle und gefällt mir auch net so ganz!

Fällt da jemand ne Lösung ein? Gibts da vllt. sogar spezielle Programme?


bin für jede hilfe dankbar!
ciao

 

[RuffRaider]

Hi

nimm doch gleich OpenOffice wenn ich dich richtig verstanden habe.

da kannste als Doc , PDF und Html speichern.


Gruß RuffRaider

 

[Xcalibur]

danke für die schnelle antwort...
so halb richtig

das problem dabei ist, dass html-dokumente im vergleich zu word eben etwas schwieriger zu bearbeiten sind und da oft Änderungen dazukommen.

Aber das größere ist, dass sich meines Wissens mit Word keine Versionskontrolle a la wikipedia realisieren lässt.

Ich sollt im Prinzip ein Wikipedia mit (funktionierender) Import-Funktion für HTML und Word haben und das gestaltet sich für mich irgendwie schwierig, such im oment auch schon in richtung Connten Management Systeme, aber da find ich bis jetzt auch nix in die Richtung.

 

[Green Mamba]

Handelt es sich um die Doku des Quellcodes, oder eher eine Art Bedienungsanleitung? Im ersteren Fall würde ich doxygen vorschlagen, im zweiten Fall ist LaTex die richtige Wahl.

 

[Boron]

Es geht hier wohl um "Bedienungsanleitungen".
Schließlich wird niemand, der normalen Verstandes ist Programmquellcode in einer doc-Datei speichern .

Was spricht dagegen einen cvs-Server (oder ähnliches) aufzusetzen?
Kommt eine geänderte Version einer Datei, wird diese dort eingepflegt (eingecheckt). Selbstverständlich mit einem aussagekräftigen Kommentat zu den Änderungen.
Auf die älteren Versionen kann man jederzeit zugreifen.

(Falls jemand meint cvs funktioniert nur mit ASCII-Dateien, dem sei gesagt, dass es auch mit Hexdateien, wie Word Docs, funktioniert. Nur können eben keine Unterschiede zur Vorgängerversion der Datei gespeichert werden, sondern immer nur die komplette Datei.)

Server sind für Linux/Unix und Windows verfügbar (cvs, bzw. cvsnt)
Grafische Oberflächen auch (gcvs , bzw, wincvs)

 

[Xcalibur]

ja, eher ne bedienungsanleitung....
hm, wie meinst du das, inwiefern soll mir Latex da weiter helfen?

von dem cvs für word hab ich auch schon gehört, ist halt wieder schade, dass da die Änderungen nicht erkannt werden. Aber da gibts für word wohl auch keine Lösung, die das erkennen kann?!

 

[Green Mamba]

Naja, bei Latex kann man z.B. jedes Kapitel in einer extra Text-Datei speichern, und einfach ändern. So hat man schon mal von der Dateistrutktur her eine schöne Unterteilung. Jede Datei kann dementsprechend geändert werden.
Zu jedem Zeitpunkt kann das gesamte Dokument in ein HTML- oder PDF- Dokument kompiliert werden, mit Bildern und allem was dazu gehört.

 

[Xcalibur]

ja, für ne neue doku hört sich das nicht schlecht an...
aber ich hab hier schon hunderte von seiten und die müsst ich ja erstmal ins latex kriegen, dann fehlt noch die versonierung

 

[Green Mamba]

Ja, das wäre ein Problem, aber es könnte sein, dass es bereits HTML->LaTex Konvertierer gibt. Vielleicht mal nach googlen. Versionierung würde ich wieder in CVS machen. Da es einfache Textdateien sind, könnte man auch bequem die Unterschiede sehen.

 

[Xcalibur]

hm, hast recht... werd mal danach schaun!

was haltet ihr von http://editthispagephp.sourceforge.net/home/index.php ?

bei mir läuft die demo leider nicht, aber vom prinzip her it es eigentlich genau das was ich gesucht hab, word in html umwandeln is ja kein problem! geht die demo bei euch?
mir stellt sich grad nur die frage wie ich meine html dokumente mit dem programm verbinde?!
seh ich das richtig, dass ich jede seite, die ich damit benutzen will über das webinterface erstellen muss?
also wenn ich richtig liege dreh ich hier bald noch durch... so viele möglichkeiten und überall gibts nen haken