Plattformübergreifende Endbenutzer-Help-Autoring-Tools

Question

Was sind einige gute Autoring-Tools zum Erstellen von plattformübergreifenden Hilfedateien für Endbenutzer? (Unsere Anwendung verwendet das QT -Framework, wenn dies einen Unterschied macht.)

Hinweis: Ich bin nicht an internen API-Dokumentation interessiert-wir werden verwenden Doxygen dafür.

Idealerweise würde eine Lösung:

• Ermöglichen Sie uns, alle Hilfeinhalte (Text, Inhaltsverzeichnis, Bilder usw.) an einem einzigen Ort zu verwalten.
• Ausgabe für native Hilfeformate. (CHM für Windows-oder zumindest etwas, das wir direkt in die HTML-Hilfe-API einfügen könnten; nicht sicher, welche "Standard" -Hilfformate der anderen Plattformen sind.)
• Anständiger Wysiwyg-Unterstützung: Gehen Sie leicht zu einem gemeinsamen Texteintrag, Bildern, Kreuzerklärungen usw., aber wir können das HTML bearbeiten, wenn wir es nötigen.
• Textbasiertes Dateiformat für Hilfsprojekt (XML usw.), damit es in Subversion versioniert werden kann.
• Alle Haken, die dazu beitragen, es in Synchronisation mit der tatsächlichen Codebasis zu halten, wären großartig. (Vielleicht ist ein Hilfesthema irgendwie mit einer Codedatei zugeordnet und kann die Subversion überprüfen, um festzustellen, ob Änderungen vorgenommen wurden, und ein Thema als "möglicherweise veraltet" zu kennzeichnen ... bin ich?)
• Hilfsinhalt kann lokalisiert werden.
• Nicht gegen kommerzielles Produkt, aber eine kostenlose Option wäre schön.

Ich werde weitermachen und dies zu einem Wiki machen und mit ein paar Beispielen beginnen. Stimmen Sie mit ihnen ab oder unten, wenn Sie Erfahrung mit ihnen haben, und hinterlassen Sie einige Kommentare. Fügen Sie auch zusätzliche Tools hinzu.

Answer 1

Ich habe gerade entdeckt Sphinx; Ich glaube, ich bin verliebt.

• Besser als wysiwyg über HTML: restrukturiertestext
• Ausgaben an QTHELP (unter anderem). Sie können also einfach in unsere Anwendung verteilen (und integrieren).
• Ich bin mir noch nicht sicher über die Lokalisierung, aber wir werden diese Brücke überqueren, wenn wir müssen.
• War leicht eingerichtet und "nur funktioniert"; Sieht professionell aus.

Answer 2

Ich habe Robohelp seit Jahren verwendet.

Es ist in Ordnung, aber die Kerntechnologie ist jetzt sehr alt. Auch die Art und Weise, wie sie sich auf Word -Versionen sperren, ist eine totale Pita (und hat mich gezwungen, MS Office -Upgrades mehrmals zu vermeiden).

Wir ziehen nach verrückter Flare http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 3

Ich finde Dokument befasst sich mit allen Anforderungen mit Ausnahme der Synchronisierungshaken, an denen ich etwas weiter nachdenken werde. Es handelt sich im Wesentlichen um eine Teilmenge von XML, die zum Erstellen von Dokumentationen entwickelt wurde, und ist kostenlos und Open Source. Es handelt sich nur um ein Format sowie ein Satz von XSL-Ausgangsumstellungen, die das Dokument in nützlichere Formate (HTML und damit CHM, Javahelp, PDF über XML-FO oder Tex) umwandeln.

Dies bedeutet, dass Sie weiterhin ein XML -Authoring -Tool auswählen müssen, um es tatsächlich zu bearbeiten, sodass WYSIWYG von den Funktionen Ihrer XML -Authoring -Software abhängt. Wir verwenden Syntext SERNA, da es eine gute Unterstützung für Wysiwyg und Inline-Bearbeitung von XML #includes hat (nein, sonst scheint es letzteres zu unterstützen). Möglicherweise finden Sie andere XML -Autoren -Tools besser zu Ihren Anforderungen - Serna ist ein einigermaßen teurer kommerzieller Angebot.

Docbook bietet eine Menge Flexibilität über Profilerstellung, mit der Sie XML -Elemente basierend auf ihren Attributen einbeziehen/ausschließen können. Beispielanwendungsfälle wären eine leicht unterschiedliche Hilfe für OS = Windows als OS = Linux. Die Lokalisierung wird auch durch Profilerstellung und andere Mechanismen unterstützt.

Ein ziemlich gut Einführung in Docbook kann gefunden werden hier.

Wir verwenden Docbook für unser Hilfesformat und kompilieren es in CHM -Dateien, die nur für die Funktionen für ein bestimmtes Produkt hilfreich sind (IE Enterprise Edition verfügt über Funktionen, die nicht in Standard- oder Demo -Versionen sind). Die entsprechenden Schritte sind:

1. Führen Sie die Profiling -XSL -Vorlagen auf der XML -Quelle (mit EG XSLTPROC) aus.
2. Führen Sie die HTML-HELP XSL-Vorlagen auf der Ausgabe von 1 aus.
3. Kompilieren Sie die Ausgabe -HTML -Dateien mit dem HTML Help Compiler (HHC) von Microsoft.

Answer 4

Hilfe & Handbuch

Answer 5

Robohelp

Answer 6

Der einzige, den ich kenne, ist Latex, einer der Latex2HTML -Konverter und dann eine Anpassung, um das resultierende HTML für den CHM -Archiver vorzubereiten.

• Text, HTML, CHM, PDF, PS kein Problem.
• Das Konvertieren in Word über RTF war früher eine Katastrophe und kenne den aktuellen Status nicht.
• Latex 2 HTML -Konverter haben, obwohl mehrere ihre eigenen Probleme haben.
• Die PDFs sehen absolut toll aus.
• Wysiwym (über lyx) möglich.

Dieses Archiv hat eine Reihe von CHMs auf diese Weise (insbesondere die Prog-, Ref- und Benutzerteile, der Rest (RTL, FCL, LCL) werden von unserem eigenen Doxygenäquivalent, FPDOC) generiert.

http://www.stack.nl/~marcov/doc-chm.zip

Beachten Sie, dass die oben genannten CHMs mit unserem eigenen (tragbaren) CHM -Compiler hergestellt werden. Ja, kein Workshop mehr.

Ein Lyx -Dokument als PDF und HTML:

PDF: http://www.stack.nl/~marcov/buildfaq.pdf

HTML: http://www.stack.nl/~marcov/buildfaq/