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.

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.

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.

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.

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.

Zitat von 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.

Hallo Uwe,

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

Zitat von 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.

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

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.

Ok verstanden. Danke.

Zitat von himitsu:

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...