Hilfesystem für Endanwender

[stalkingwolf]

Moin,

wir wollen unser Hilfesystem und die Dokumentation überarbeiten und wollte einmal fragen wie ihr das gelöst habt.

Aktuell machen wir dies relativ simpel über PDF Dateien. Jedes Programm/Modul erhält ein eigenes Dokument welches wird in Word schreiben, dann in PDF wandeln und die Kunden habe diese in einem Ordner unseres Systems.
Dazu haben wir einen kleinen Browser geschrieben welcher die Dokumente den Modulen zuordnen.

So schön so gut.
Das ist teilweise extrem aufwändig zu pflegen. Worddatei ändern -> PDF Datei generieren ( richtige Kompression nutzen, sonst sind die Bilder zu verpixelt ) -> ausrollen. ( wir sprechen hier von fast 100 Modulen ).

Dazu ist es für den Endanwender unmöglich richtig zu Suchen in den Dokumente, weil der Endanwender schon quasi wissen muss welches das korrekte Modul und damit PDF Dokudatei.

Was mir dabei wichtig wäre. Das ganze sollte Offline funktionieren, evtl mit dem Programm verbunden sein ( muss nicht unbedingt ).
Es sollte relativ einfach einzurichten oder sogar autark laufen. D.h z.b keine Wiki wo wir erstmal einen Wikiserver einrichten müssen.
Wir haben Kunden mit Infrastruktur welcher wir administrieren und Kunden die nutzen unsere Software als Einzelplatz auf einem Notebook.
Letztere sind sogar eher die Kunden welche die Hilfe benötigen. Große Kunden organisieren sich oft selbst in internen Schulungen und Ablaufplänen.

[Der schöne Günther]

Warum ist das zu komplex? Doppelklickt jemand jede Word-Dateien einzeln und klickt sich dann jedes mal durch "Speichern Unter > PDF"? Das lässt sich doch komplett automatisieren, sogar mit einer Batch-Datei!

Und solange sich international keiner dran stört wenn er kein A4-Papier hat ist PDF doch eine super Wahl. Inhaltsverzeichnis, Sprungmarken, läuft überall.

[Uwe Raabe]

Ich verwende Help & Manual zur Erstellung der Hilfe (CHM) und der Handbücher (PDF). Es gibt dann nur eine CHM- und eine PDF-Datei, die beide aus demselben H&M-Projekt erstellt werden, die Texte also nur einmal erstellt bzw. bearbeitet werden müssen. Als Nebeneffekt fällt auch noch eine kontextsensitive Hilfe ab, wenn man die Keywords an passender Stelle im Programm setzt. Das Ganze hat sich in den letzten Jahren als sehr robust und flexibel herausgestellt.

[himitsu]

In Netzwerken/Firmennetzwerken muß man aber aufpassen, da wichtige Teile von HTML-Hilfen (CSS/JS) standardmäßig teilweise vom IE/Edge gesperrt werden, wenn man die Hilfedatei aus dem Intranet/Share lädt.
Wichtig: Die Lösung dafür von Help&Manual sollte darf man nicht verwenden, da deren Webserver-App unsicher ist und ein soooo großes ungesichertes Backdoor ins System bringt ... dafür gibt es kein Wort.

[rapante]

Wir haben in unserem Programm über die Kontext-Hilfe ein Wiki integriert. Drückt der Anwender in einem Modul F1 gelangt er direkt an die richtige Stelle im Wiki.
Langfristig werden wir auch auf 'Help & Manual' umstellen, da das Erstellen dort einfacher ist als mit unserem derzeitigen Wiki.

[stalkingwolf]

Zitat:

Zitat von Uwe Raabe (Beitrag 1485320)

Ich verwende Help & Manual zur Erstellung der Hilfe (CHM) und der Handbücher (PDF). Es gibt dann nur eine CHM- und eine PDF-Datei, die beide aus demselben H&M-Projekt erstellt werden, die Texte also nur einmal erstellt bzw. bearbeitet werden müssen. Als Nebeneffekt fällt auch noch eine kontextsensitive Hilfe ab, wenn man die Keywords an passender Stelle im Programm setzt. Das Ganze hat sich in den letzten Jahren als sehr robust und flexibel herausgestellt.

Hallo Uwe,

danke für den Tipp, wird werden uns das einmal anschauen.

[stalkingwolf]

Zitat:

Zitat von himitsu (Beitrag 1485322)

In Netzwerken/Firmennetzwerken muß man aber aufpassen, da wichtige Teile von HTML-Hilfen (CSS/JS) standardmäßig teilweise vom IE/Edge gesperrt werden, wenn man die Hilfedatei aus dem Intranet/Share lädt.
Wichtig: Die Lösung dafür von Help&Manual sollte darf man nicht verwenden, da deren Webserver-App unsicher ist und ein soooo großes ungesichertes Backdoor ins System bringt ... dafür gibt es kein Wort.

Die Aussage verstehe ich nicht ganz. Wenn das Programm PDF und CHM Dateien ausspuckt, dann muss doch keine Webserver-APP von denen eingesetzt werden?

[himitsu]

CHM ist eigentlich eine ZIP, mit HTML/CSS/JS drin und für die Anzeige wird ein eingebetteter IE verwendet.

Wir nutzen von Help&Manual die direkte HTML-Hilfe, welche wir aber über einen eigenen TIdHTTPServer rausgeben, um nicht bei jedem einzelnen Rechner die Trusted-Zonen anpassen zu müssen.
(das Internet ist halb gut, aber das Intranet wird standardmäßig als ganz böse eingestuft)
Mit dieser Variante hatten wir bei unseren Kunden am häufigsten, dass es ohne Umstände funktioniert.
Und gleichzeitig können wir die "selbe" Hilfe so auch über's Internet abrufen. (wenn man den Port öffnet)

Das ist grade der Witz.
HTML-Zeugs von einem Share, über den man die Kontrolle mit Nutzerberechtigungen hat, das ist für den IE unsicher.
Aber wenn man Dateien über HTTP ungeschützt im Netzwerk rausgibt, dann ist das sicher. (laut dem IE)
Die App, welche von Help&Manual bereitstellt, prüft aber keinen Zugriff. Da kannst einfach C:\irgendwas als Pfad übergeben und die Anwendung gibt es dir.
Außerdem läuft die App nicht als Service und wenn man sie nicht in einem geschützten Nutzer laufen lässt, dem fast alles verboten ist (was die dir aber nicht dazu sagen), dann kann irgendwer im Netzwerk fast alles runterladen.

[stalkingwolf]

Ok verstanden. Danke.

[Harry Stahl]

Zitat:

Zitat von himitsu (Beitrag 1485326)

CHM ist eigentlich eine ZIP, mit HTML/CSS/JS drin und für die Anzeige wird ein eingebetteter IE verwendet.

Ach, interessant, wusste ich auch noch nicht. Scheint aber 7-Zip zu sein, mit dem in Delphi integrierten Zip kann man es nicht öffnen.

Aber gut zu wissen, falls man nur eine .chm-Datei haben sollte, kann man so ganz einfach den Kram extrahieren und kann dann es dann konvertieren.

Muss mal schauen, ob ich was einfaches finde, womit ich die 7zip-Datei auch mit Delphi öffnen kann, dann würde ich das in mein eigenes CrossHelp-Programm direkt integrieren.

Ich habe inzwischen alle meine Programme auf diese (eigene) Lösung umgestellt, zumal ich so eine vernünftige Hilfe (inclusive Volltext-Suche) auf allen Desktop-Plattformen (Windows, macOS und Linux) habe...

[himitsu]

Es sollte schon eine richtige ZIP sein,
aber die Implementation im Delphi ist etwas abgespeckt und versteht nicht jede Feinheit.

Praktisch ist es auch möglich die Dateien als Ressource in eine EXE oder DLL zu legen und sie extern zu öffnen.
https://docs.microsoft.com/en-us/pre...67740(v=vs.85)

[KodeZwerg]

Zitat:

Zitat von Harry Stahl (Beitrag 1485382)

Muss mal schauen, ob ich was einfaches finde, womit ich die 7zip-Datei auch mit Delphi öffnen kann, dann würde ich das in mein eigenes CrossHelp-Programm direkt integrieren.

Schau mal ob Dir das weiterhilft. (der untere 7zip link)

[Delphi.Narium]

CHM sind weder noch waren sie je ZIP oder 7-Zip. Aber es ist komprimiert (seit jeher) mit Windowsmitteln.

https://en.wikipedia.org/wiki/Micros...iled_HTML_Help

https://www.delphipraxis.net/133590-chm-dump.html

Das Interface dazu müsste in der itss.dll zu finden sein (wenn sie bei aktuellen Windowsen noch dabei sein sollte).

[Andreas13]

Aber 7-ZIP kann sie trotzdem öffnen...
Graß, Andreas

[Harry Stahl]

Zitat:

Zitat von KodeZwerg (Beitrag 1485385)

Zitat:

Zitat von Harry Stahl (Beitrag 1485382)

Muss mal schauen, ob ich was einfaches finde, womit ich die 7zip-Datei auch mit Delphi öffnen kann, dann würde ich das in mein eigenes CrossHelp-Programm direkt integrieren.

Schau mal ob Dir das weiterhilft. (der untere 7zip link)

Zitat:

Zitat von KodeZwerg (Beitrag 1485385)

Zitat:

Zitat von Harry Stahl (Beitrag 1485382)

Muss mal schauen, ob ich was einfaches finde, womit ich die 7zip-Datei auch mit Delphi öffnen kann, dann würde ich das in mein eigenes CrossHelp-Programm direkt integrieren.

Schau mal ob Dir das weiterhilft. (der untere 7zip link)

Super Tipp, danke Dir ganz herzlich, KodeZwerg.:thumb:

Mit der 7Zip.dll kann man die Datei direkt im chm-Format öffnen:

Delphi-Quellcode:

 with CreateInArchive(CLSID_CFormatChm) do
 begin
   OpenFile(edChm.text);

Habe ich direkt in mein Programm, Version 1.02 eingebaut (unter Register "HTML-Projects, dort "Import CHM-file"), man kann also kurzerhand aus der CHM-Datei ein CHM-Projekt machen und das in ein Cross-Help-Projekt konvertieren, Zeitaufwand < 1 Minute... (https://www.crosshelp.de/)

[KodeZwerg]

Zitat:

Zitat von Harry Stahl (Beitrag 1485396)

Super Tipp, danke Dir ganz herzlich, KodeZwerg.:thumb:

Gerne doch! Klasse das es auf anhieb funktioniert hat, so wünscht man es sich hehe

Beim besuchen Deiner Seite ist mir kurz vorm verlassen ein mini Schreibfehler aufgefallen.

Zitat:

By buiying the full version you will receive a registration-number. After you have inputed the number the program will become a full version.

buiying gibt es im englischen noch nicht :-)

Der Seite fehlt auch im Browser ein FavIcon.

Eine Frage noch, ist das Produkt abgesehen vom "made with demo"-stamp voll funktionstüchtig? (noch habe ich es nicht geladen)

[Harry Stahl]

Zitat:

Zitat von KodeZwerg (Beitrag 1485398)

By buiying the full version you will receive a registration-number. After you have inputed the number the program will become a full version.
buiying gibt es im englischen noch nicht :-)

Der Seite fehlt auch im Browser ein FavIcon.

Eine Frage noch, ist das Produkt abgesehen vom "made with demo"-stamp voll funktionstüchtig? (noch habe ich es nicht geladen)

Na, das ist ja ein Service, danke behoben (außer Favicon, funktioniert irgendwie nicht).

Zu Deiner Frage: Ja, das ist die einzigste Einschränkung der Demo, sonst funktioniert alles.

[Delphi.Narium]

Zitat:

Zitat von Andreas13 (Beitrag 1485391)

Aber 7-ZIP kann sie trotzdem öffnen...
Graß, Andreas

7-Zip kann mehr Formate öffnen, als das 7-Zip-Format. Sprich: Wenn 7-Zip was öffnen kann, ist das nicht zwingend im 7-Zip-Format.
Und das bezog sich auf das

Zitat:

Zitat von Harry Stahl

Ach, interessant, wusste ich auch noch nicht. Scheint aber 7-Zip zu sein, mit dem in Delphi integrierten Zip kann man es nicht öffnen.

Und wenn's nun eine Lösung mit der 7Zip.dll gibt, ist ja alles ok. Derweil das CHM-Format über das Interface zur itss.dll zu bearbeiten, ist nicht zwingend so ganz simpel.