Hilfe Dateien erstellen

[himitsu]

Zitat von Windows-Hilfe:

"Hilfe und Support" funktioniert nicht, gehen sie in "Hilfe und Support" und suchen sie nach einer Lösung.

Wir lassen uns aktuell von Help&Manual eine HTML-Hilfe generieren. (die und andere Programme können noch mehr, aber reines HTML war das was fast überall geht, ohne dass man was machen muß, auf jedem einzelnen Client-PC)

Die Hilfe ist einmal online (ganz aktuell), aber auch nochmal im Programm.
Also quaso so ähnlich, wie auch im Delphi die OH (lokal) und DocWiki (online).

Da es aber im Intranet extrem beschissene Standardeinstellungen für InternetExplorer/Edge gibt, wo teilweise CSS und JavaScript geblockt wird, weil Intranet nicht als "Sicher" eingestuft ist.
Help&Manual hat dafür eine kleine EXE, die einen lokalen WebServer erstellt und darüber die Hilfe rausgibt, allerdings ist das Ding sicherheitstechnisch eine Katastrophe, weswegen ich in unserem Service einen TIdHTTPServer laufen hab, der einfach aus einem bestimmten Verzeichnis Dateien rausgibt (Abfrage nur Dateiname ohne Pfad erlaubt).

Und im Programm ist bei jeder Form HelpIndex=100 drin, damit die F1-Taste reagiert, auch wenn sonst in der DFM keine Hilfe direkt verlinkt ist.
In einem TApplicationEvents.OnHelp wird dann global drauf reagiert.
* bei aktiver Komponente, deren Parents, bis hin zur Form ... da wo zuerst was gefunden wird, das wird genommen
* entweder HelpKeyword als Link
* und es gibt eine Tabelle in der DB, mit ComponentName+FormClassName zu HilfeDateiName (alternativ eine externe URL, z.B. zu unserem Redmine)
* und dann noch ein Setting
** interne Hilfe -> ein TWebBrowser
** externe Hilfe -> Standardbrowser
** und die URL wählbar -> z.B. im Intranet zum Service oder über's Internet auf unserem WebServer
*** es ginege sogar über das filerotokoll auf ein lokales Verzeichni, bzw. auf ein Netzlaufwerk

[TigerLilly]

Wir haben früher unsere Hilfe sehr detailliert mit Doc-O-Matic erstellt, als CHM, HTML und PDF. Wir sind dann aber dazu übergegangen, in der Hilfe nur mehr Basis-Infos bereitzustellen und Abläufe und tiefergehende Infos in Videos und Tutorials auszulagern. Die zu erstellen macht viel mehr Spaß und bringens tausendmal mehr. Hilfe liest keiner, aber die Videos schaut sich jeder an.

[Rollo62]

Zitat von TigerLilly:

Die zu erstellen macht viel mehr Spaß und bringens tausendmal mehr.

Schön und gut, aber automatisch Doc-o-Matic ubnd manuell Videos erstellen ist ein Unterschied.
Ist das nur intern oder auch für Kunden ?
Wieviel mehr Zeit braucht man für gute Videos die man den Kunden zumuten kann ?

Ich finde Videos auch schön, aber wenn ich ehrlich bin:
- Es ist oft Zeitverschwendung 15min zu schauen, für 15Sek. relevante Info die ich brauche
- Ich kann nicht in Videos suchen
- Ich kann nicht aus Videos Code kopieren
...

Ich finde z.B. den Aufbau und Funktion von Embarcaderos DocWiki (also HTML5) einfach super,
und die sollten wirklich auch die F1-Hilfe direkt auf DocWiki umleiten.

Videos können dann gut ergänzend gemacht werden um Konzepte zu erklären.

[TigerLilly]

Ich rede von Hilfe + Video für Kunden, Endbenutzer unserer Software. Nicht interne Doku von Code. So hatte ich den TE verstanden.

@Videos für Endkunden: Wir schauen, dass die ca. 15 Minuten lang sind und sich auf ein Thema konzentrieren. Wir haben Templates für Intro/Outro und den grundsätzlichen Aufbau. Mittlerweile haben wir schon Routine, so dass die Roh-Erstellung selbst ca. 1 Stunde dauert + das Nachbearbeiten (Schneiden, Tonspur bereinigen, Hervorhebungen, Animationen) ca. 2h.

Wie gesagt, für uns funktioniert das sehr super, die Videos erfüllen auch im Vertrieb eine wichtige Funktion, weil die Interessenten sehen, wie die Software tut + was sie kann.

[Rollo62]

Zitat von TigerLilly:

... ca. 1 Stunde dauert + das Nachbearbeiten (Schneiden, Tonspur bereinigen, Hervorhebungen, Animationen) ca. 2h.

[himitsu]

Und auf Youtube hochladen, damit der wer Hilfe sucht beim Spulen erst 5 Werbungen sehen muß, bis er nach effektiv 20 Sekunden Video vielleicht die passende Stelle gefunden hat.

[TigerLilly]

Zitat von himitsu:

Und auf Youtube hochladen, damit der wer Hilfe sucht beim Spulen erst 5 Werbungen sehen muß, bis er nach effektiv 20 Sekunden Video vielleicht die passende Stelle gefunden hat.

Na, es gibt andere Plattformen auch + selber hosten geht auch immer. Aber wie gesagt: Für uns funktioniert das gut.

Zitat von philipp.hofmann:

Das ist auch mein aktueller Weg, die schriftlichen Dokus liest jeder nur ungerne und Videos sind Demo und Hilfe zugleich, aber auch ungleich mehr Aufwand, das will ich nicht von der Hand weisen.

Kann ich nicht sagen. Eine gute(!) schriftliche Doku ist extrem aufwändig. Meiner Erfahrung nach, bist du mit dem Video bei 50% des zeitlichen Aufwands der schriftlichen Doku. Denk nur an Layout, Verweise, ScreenShots etc.

[philipp.hofmann]

Das ist auch mein aktueller Weg, die schriftlichen Dokus liest jeder nur ungerne und Videos sind Demo und Hilfe zugleich, aber auch ungleich mehr Aufwand, das will ich nicht von der Hand weisen.

[Rollo62]

Videos haben auf jeden Fall den "Coolness-Faktor"

[Moombas]

Zitat von philipp.hofmann:

Das ist auch mein aktueller Weg, die schriftlichen Dokus liest jeder nur ungerne und Videos sind Demo und Hilfe zugleich, aber auch ungleich mehr Aufwand, das will ich nicht von der Hand weisen.

Würde ich nicht mal sagen. Das Thema hatten wir ja schon ein paar mal.
Es kommt ganz auf den Nutzer an und was er will.
Ich selber lese lieber und probiere es dann selber mit wenigen Ausnahmen wo ein Video ggf. im Einzelfall ein Problem besser behebt (wo zum Henker finde ich dieses Menü).

Auch kann man Beispiele aus einer Text Doku gut raus kopieren anstatt dies dann auf Pause vom Videobild abzutippen und dann auch noch Gefahr läuft Fehler einzubauen.

Das Beste ist einfach ein gesunder Mix. Meine Traumvorstellung:

1. Im Programm selber eine Hilfe öffnen können mit allen möglichen Themen in Schrift/Bild form. (Kann ja auch eine Webseite sein.)
2. In den Themen, falls wirklich Hilfreich, Verlinkungen zu passenden Erklärvideos.

Das Einzige was eine Hilfe wirklich unattraktiv macht, ist in der Regel, wenn sie nicht gepflegt wird (Menüpunkte gibt es nicht (mehr) oder liegen woanders, aktuelle/ neue Probleme werden nicht mit aufgeführt. Ganz nach dem Motto: Das Internet wird es schon regeln).