Forum: PC-Programmierung Hilfe - State of the Art?


von Borislav B. (boris_b)


Lesenswert?

Hi,
angenommen ich entwickle eine Software, und möchte dieser auch eine 
Hilfe beilegen. Diese soll einerseits vom Anwender "frei" durchforstet 
werden können, aber andererseits auch aus entsprechenden Kontexten 
heraus geöffnet werden können. Eine schöne Suchfunktion (a la Google) 
soll sie auch haben.

Was wäre ein "State of the Art" Ansatz, so eine Hilfe zu bauen?
 - Eine Online-Webseite? Gibt es da spezielle CMS um so eine Seite zu 
bauen?
 - Eine Offline-Webseite, die mitinstalliert wird?
 - Eine Mischung aus Online (primär) und Offline (Fallback) Seite?
 - Diese komischen CHM-Dateien?
 - PDF-Dokumente?
 - Proprietäre Software?
 - ???

Bin für jede Anregung dankbar!

PS:
Die Hilfe sollte natürlich auch so erweiterbar sein, dass verschiedene 
Software Versionen und Varianten berücksichtigt werden können.

von Läubi .. (laeubi) Benutzerseite


Lesenswert?

Boris P. schrieb:
> Bin für jede Anregung dankbar!

Anregung wäre mal das Betriebsystem und die Programmiersprache zu 
nennen...

von Vlad T. (vlad_tepesch)


Lesenswert?

unter windows finde ich die chm eigentlich gar nicht so schlecht. sie 
haben nicht den Nachteil, dass man 1000de Files im Dok Ordner rumliegen 
hat, was immer ewigkeiten beim kopieren oder löschen dauert.

qt hat sowas ähnliches wie chm:
http://qt-project.org/doc/qt-4.8/qthelp-framework.html

Anonsten hab ich auch schon ordentlich durchsuchbare (mit javascript) 
offline-html-Hilfen gesehen.

von Borislav B. (boris_b)


Lesenswert?

Läubi .. schrieb:
> Anregung wäre mal das Betriebsystem und die Programmiersprache zu
> nennen...

Das halte ich für irrelevant.

Eine Hilfe zu öffnen sollte aus jeder gängigen Programmiersprache 
möglich sein. Wenn die Hilfe auf Webtechnologien basiert sollte sie 
zudem auf jedem Betriebssystem lauffähig sein.

von Vlad T. (vlad_tepesch)


Lesenswert?

Boris P. schrieb:
> Wenn die Hilfe auf Webtechnologien basiert sollte sie
> zudem auf jedem Betriebssystem lauffähig sein.

chm und qthelp basieren auch auf gängigen webtechnologien.
Allerdings braucht es ein Tool, was mit den Containern umgehen kann.

von Läubi .. (laeubi) Benutzerseite


Lesenswert?

Boris P. schrieb:
> sollte

Sollte müßte könnte... Trotz allem ist es einfache konkrete Tipps zu 
geben wenn die Systemumgebung bekannt ist. Wozu die ultimative 
generische Lösung wenn es die spezielle einfach umzusetzende in seiner 
Umgebung tut.

(Persönlich Meinung: Hilfe liest eh keiner...)

von ppmx (Gast)


Lesenswert?

Läubi .. schrieb:
> Boris P. schrieb:
>> sollte
>
>
> (Persönlich Meinung: Hilfe liest eh keiner...)

Genau, lieber auf µC-net Fragen stellen. Da gibt wenigstens ein bisschen 
(a)soziale Interaktion dazu.

pr0-Tipp: Alles was Volltext-Suche, Links und Bilder unterstüzt ist 
nicht verkehrt. Mit PDF kann man relativ wenig falsch machen.

von Vlad T. (vlad_tepesch)


Lesenswert?

ppmx schrieb:
> Mit PDF kann man relativ wenig falsch machen.

naja, da von der Software über F1 ein bestimmtes Kapitel anspringen, 
erfordert schon eine menge Annahmen, was installierte Software angeht.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.