HTML Frage zum Erstellen einer H.i.l.f.e Datei zu einem komplexen Programm...

[Zockermann]

Hallo Community,

ich komme heut mit einer nicht einfach zu beantwortenden Frage zu euch (zumindest für mich ist diese nicht einfach zu beantworten).

Ich wurde mit der Aufgabe betreut (obwohl noch nie so etwas gemacht) eine Hilfe zu einem recht komplexen Programm zu schreiben. Um mit diesem Programm arbeiten zu können müssen die Anwender i.d.R. an mehreren Schulungen teilnehmen da es sonst sehr schwierig wird. Das Programm selbst beherrsche ich, ist also nicht das Problem.

Leider gibt es keine sonderllich gute Hilfe (hier eine CHM Datei - kompilierte HTML) und ich möchte nicht einfach nur Texte anpassen. Das wäre eine schnelle, aber keine besonders schöne Lösung. Kennt jemand ein Programm oder hat eine Idee die mir bei der Umsetzung helfen kann ?? Ich denke dabei nicht an Programme wie zB Dreamweaver da das einarbeiten länger dauert als das Schreiben der Hilfe. Grundlegende HTML Kenntnisse sind vorhanden, mehr aber auch nicht.
Ich weiß das es sicherlich nicht leicht ist darauf zu antworten aber ich bin für jeden Tipp dankbar.

Danke im Voraus

Zockermann

 

[Madman1209]

Hi,

daraus werde ich nicht schlau. Was verstehst du unter "schnell aber nicht schön"? Was ist denn dann "schön"? Eine Hilfe sollte klar strukturiert, sachlich korrekt und nüchtern sein. Was genau hast du vor und woran hapert es? So ist das nicht wirklich klar. HTML Datei erstellen (SelfHTML lässt grüßen) und fertig. Alles andere ist Inhalt (dein Teil) oder Design (CSS). Beides geht nicht ohne Kenntnisse, die kann dir aber keiner Abnehmen.

VG,
Mad

 

[sankura]

kannst auch einfach nen internes wiki aufsetzen find sowas mittlerweile am besten für dokumentationen

 

[Zockermann]

Danke für die schnellen Antworten. @mad -> Ich dachte da eher ans Design wie du richtig vermutest. Nur wenn ich mich erst groß einarbeiten muss bringt das nicht viel da ich leider auch nicht ewig Zeit habe um es zu realisieren.

@sankura: Sorry für die Nachfrage aber von einem "internen Wiki" habe ich noch nichts gehört. Muss ich mir das wie das Online Wiki vorstellen ? Gibt es Tools die mir dabei helfen können das zu realisieren ??

Hab grad mal geschaut - meinst du das hier ?? meinst du mediawiki.org ??

 

[Madman1209]

Hi,

Muss ich mir das wie das Online Wiki vorstellen ?

genau so ist es. Wiki Installation ist ruckzuck erledigt, gibt etliche Anleitungen.

VG,
Mad

 

[Zockermann]

Danke für den offensichtlich klasse Hinweis !! Werde das antesten - Danke nochmal !!!

Zockermann

 

[sankura]

und hat den Vorteil das sie mit dem Programm mitwachsen kann und du eventuell auch andere findest die dir beim dokumentieren helfen.

 

[Zockermann]

Muss da nochmal was nachfragen. Die Hilfe muss ja im Zuge der Installation auf auf jedem Kundenrechner installiert werden. Wenn ich mir die Installation requirements anschaue frage ich mich ob dann auch beim Kunden all dies installiert werden muss um das fertige Wiki nutzen zu können ??

A web server is required to send the generated pages to your web browser.
PHP is required to run the software.
A database server is required to store the pages and site data.

 

[Daaron]

Du besorgst dir eine Webhosting-Lösung nebst Domain, auf der die Wiki läuft. Deine Kunden (und alle anderen Interessierten) navigieren das dann normal als Webseite.

 

[Zockermann]

OK, das habe ich verstanden... ich glaube nur das dies alles einzurichten und die Seiten zu erstellen wesentlich länger dauern wird als die vorhandene CHM Datei aufzupeppen und anzupassen. Danke trotzdem für eure Hilfe..

 

[westef]

Ich kann dir auch "Sphinx" ans Herz legen. Homepage ist http://sphinx-doc.org/. Beispielsweise ist die gesamte Python-Dokumentation mit Sphinx realisiert und natürlich auch die Sphinx-Dokumentation selbst.

Den Text schreibt man dabei in reStructuredText. Das ist ähnlich wie Markdown eine Auszeichnungssprache, also z.B. **bla** wird fettgeschrieben, für Listen schreibt man einfach ein "* " vor den Eintrag etc. Sphinx wandelt diese Textdateien dann wahlweise in HTML, PDF, ePub etc. um, generiert automatisch ein Inhaltsverzeichnis etc.

Das Einrichten ist leider nicht ganz so trivial, aber man kann damit echt schöne Dokumentationen basteln.

edit: Eine Eingabedatei sieht beispielsweise so aus: http://sphinx-doc.org/_sources/tutorial.txt
Und die generierte HTML-Seite: http://sphinx-doc.org/tutorial.html