Hilfefunktion per URL

[Alpha96]

Auch ich mag die Hilfeseiten im Internet nicht! Schön, daß es sie gibt! Aber sie sind kein Ersatz für eine Offline-Hilfe, schon gar nicht dann, wenn ich gerade keine Zugriff auf das Internet habe (oder haben will), warum auch immer. Aber auch prinzipiell ist mir eine Offline-Hilfe immer die Liebere! Nicht alles, was modern ist, muß man mitmachen.

Kontextsensitiev ist nätürlich am besten und HTML besser als gar nichts. CHM das bevorzugte Format. Und auch hier gilt: Neu ist nicht automatisch besser.

[Lunovus]

Ich bevorzuge auch CHM (oder wie auch immer unter jeweiligem OS bzw. kontextsensitiver "Standard-Hilfe" einer bestimmten Entwicklungumgebung).

Im Idealfall hat man doch sowieso nur eine "Quelle" für Hilfe und Dokumentation, und die Doku-Build-Toolchain wirft einem dann HTML, div. kontextsensitive Hilfsformate und LaTex (zum hübschen PDF erzeugen) aus.

[NoSi]

Ich bin selbst Programm-Entwickler und war – bis vor ca. 1,5 Jahren – selbst glühender Anhänger lokaler Hilfedateien. Das hat sich nach einer Bewertung diverser Aspekte geändert:

Aus Anwendersicht:

• Die Kontexthilfe in den meisten Programmen führt mich auf isolierte Antworten, die mir nur helfen, wenn ich im Grunde die Antwort eh weiß, nur unsicher bin. Zum Verstehen fängt das wilde Klicken an – und dafür fehlen die Querverweise oder es wird eine endlose Klickorgie durch unzählige Erklär-Fragmente, die weiterer Erklärungen bedürfen.
• Die CHM-Hilfen stürzen immer häufiger direkt nach dem Start unter W10x64 und W11 regelmäßig ab und sind deshalb unbenutzbar. Weil es häufig keine Online-Hilfe und auch kein Handbuch gibt (mögliche Gründe s. nächste Gruppe), habe ich gar keine Hilfe.
• CHM-Hilfen sind häufig mehr oder minder stark veraltet.
• Es gibt keine „unscharfe“ Suche, weshalb keine Treffer möglich sind, wenn der genaue Suchbegriff unbekannt ist.
• Ich sehe sehr häufig den Dialog [keine Themen gefunden].
• Es ist keine „kombinierte“ Suche möglich, mit der sich aus einem Trefferfeld die geeignetsten Treffer herausfiltern lassen.
• Keine Skaliermöglichkeit für die Seitenleiste (Index, Inhalt, …). Ich arbeite auf einem Großbildschirm, Index, etc. sind und bleiben dort mikroskopisch klein. Bei diversen CHMs ist ebenfalls keine Skalierung des Haupttextes möglich.
• Bei der Suche bekomme ich Überschriften, bei denen die Antwort auf meine Suche meist hinter der liegt, die ich als letzte anklicke, weil der Kontext fehlt.
• Ich habe ein weiteres Programmfenster offen, das andere Programme überdeckt.

Aus Entwickler-Sicht

• CHM-Hilfen sind Strafarbeit. Die Erstellung und Pflege ist extrem Zeitaufwendig und Fehleranfällig.
• Kontext-Hilfe ist erheblicher Zusatzaufwand bei der Programmierung und Pflege.
• Ca. 90% der Kundenanfragen sind KHG-Fragen – Kein Handbuch gelesen. Für die spielt die Darreichungsform keine Rolle, wird so oder so ignoriert (habe alles durch: Papierhandbuch + Kontext, PDF + Kontext, Online, alle Kombinationen daraus).
• Der Rest fragt nach, weil die Beschreibung im CHM/Handbuch unklar ist → weshalb ich
  1. … am Telefon / per E-Mail antworten muss (= Zeitaufwand, den ich sowieso habe und der mir auch nützt, weil ich dadurch die Sachen „aus Kundensicht“ betrachten und bewerten kann).
  2. … das in die Hilfe einpflegen muss (ist zumindest empfehlenswert, dadurch habe ich selten zweimal die gleiche Frage)
  3. … ein neues CHM kompilieren und bereitstellen muss – das aber eine „alte“ Version haben muss, denn nur die läuft mit der Programmversion bei den Kunden, parallel muss ich die für die nächste Version pflegen. Aktualisierte CHMs wurden allerdings selten bis nie abgerufen – viel Arbeit für nix…
  4. … das Handbuch pflegen und als neues PDF bereitstellen → Für die nächste Version wird Text in Kommentaren ergänzt und bei der Programmfreigabe „sichtbar“ gemacht.

Mittlerweile gehe ich einen hybriden Weg: Es gibt lokal eine HTML-Hilfe, die wesentliche Infos – speziell für Einsteiger – enthält und Links zu den Hilfegruppen der Online-Hilfe. Es gibt keine PDF-Handbücher mehr, das steht alles Online. Dafür sorge ich für schnelle Updates des Programms, damit die Online-Hilfe zum Programm passt → es gibt (für mich und die Kunden) nur eine Version: Die aktuellste.

„Meine“ Online-Hilfe ist genau genommen eine „allgemein lesbare“ Programmdokumentation in „Prosa“ für mich selbst. Denn damit kann ich selbst nachsehen, was ich mir vor zig Monaten/Jahren evtl. bei einer Funktion gedacht habe und wie sie funktionieren soll. Seit ich das so mache, habe ich weniger Nachfragen von denjenigen, die „Hilfe benutzen“. Ich erhalte von Anwendern konkrete Hinweise (mit Link zur Position – steht auf jeder Hilfeseite in der Fußzeile…), wo z.B. ein Fehler oder eine Unklarheit drin steht. Das kann ich schnell korrigieren und es steht sofort allen Nutzern zur Verfügung.

Wer die Hilfe in „onlinefreier Zone“ nutzen will oder muss, dem empfehle ich HTTrack für lokale Webseiten-Kopien – das Tool kopiert eine komplette Website in einen lokalen Ordner. Allerdings bin ich damit als Anbieter raus, was die aktualität betrifft – das liegt in der Obhut des Anwenders, der sich selbst darum kümmern muss, die „lokale“ Hilfe aktuell zu halten.

[einposter]

@NoSi:

[FFF]

Während die Beschreibung auf den Alltag durchaus zutrifft, würde ich aber einwenden, dass gerade die SM Hilfe hier ein leuchtendes Beispiel ist, wie man es richtig gut macht. Wenn das für SM Strafarbeit ist, nun, auch dafür wird der Kollege bezahlt. Ich als Nutzer empfinde es seit Jahren als nahe an perfekt.

[Gariniranus]

[martin-k]

Mehrfach wurde hier geschrieben, dass unsere HTML-Hilfe nicht kontextsensitiv sei. Das stimmt nicht, sie ist genauso kontextsensitiv wie die frühere CHM-Hilfe.

[FUM]

Einige der Argumente pro Onlinehilfe kann ich nicht nachvollziehen.

Klar ist Dokumentation/Erstellung einer Hilfe eine ungeliebte Aufgabe. Das trifft aber für alle Arten zu.
Wenn sie nicht gepflegt wird ist jede Hilfe veraltet. Und es gibt natürlich auch jede Menge schlechte CHM formatierte Hilfen.

Das man dank einer guten Hilfe weniger Supportanfragen hat, merkt man halt als Programmierer nicht. Dass immer weniger in der Hilfe nachschauen hängt auch damit zusammen, dass diese bei vielen Softwarefirmen immer schlechter wird (wenn es überhaupt noch eine gibt). Manchmal wird man ja nur noch auf Videos verwiesen!
Da gehörte Softmaker bisher zu den Ausnahmen. Auch die jetzige HTML-Hilfe ist auf jeden Fall besser als bei vielen anderen Programmen.

Die reine HTML-Hilfe (obwohl sie wie richtig angemerkt wurde kontextsensitiv ist) bietet mir aber nur einen geringen Mehrwert zum PDF-Handbuch. Dort kann ich mir z.B. Lesemarken setzen, Anmerkungen reinschreiben usw.

Die Probleme mit damit hat ja KSI sehr gut aufgezeigt.

Einer der Gründe (von vielen) warum ich nach Möglichkeit versuche Programme mit einer "rolling release" Veröffentlichsstrategie bzw. Abos meide ist, dass oft die Hilfe nicht entsprechend mit gepflegt wird.

Wenn die Dokumentation nur noch online vorliegt, was ist wenn man bei einer alten Version bleiben will oder die Firma das Produkt aufgibt usw. ? Ich nutze durchaus noch über 20 Jahre alte Software, bei denen die Hilfe und Dokumentation immer noch funktioniert.

Ich hoffe Softmaker bleibt bei der Veröffentlichung von Majo-Releases mit neuen Funktionen und Minor-Updates mit Bugfixes!