Plattformübergreifende Autorenwerkzeuge für die Endbenutzerhilfe

8

Was sind einige gute Authoring-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 der internen API-Dokumentation interessiert - wir verwenden doxygen dafür.

Idealerweise wäre eine Lösung:

  • Erlauben Sie uns, alle Hilfeinhalte (Text, Inhaltsverzeichnis, Bilder usw.) an einem einzigen Ort zu verwalten.
  • Ausgabe in native Hilfeformate. (CHM für Windows - oder zumindest etwas, das wir direkt in die HTML-Hilfe-API einspeisen könnten; nicht sicher, welche "Standard" -Formate für andere Plattformen es sind.)
  • Angemessene WYSIWYG-Unterstützung: einfache Texteingabe, Bilder, Querverweise usw. können problemlos verarbeitet werden, aber wir können den HTML-Code bei Bedarf bearbeiten.
  • Textbasiertes Dateiformat für Hilfeprojekte (XML, etc.), damit es in Subversion versioniert werden kann.
  • Irgendwelche Haken, die helfen, es synchron mit der tatsächlichen Code-Basis zu halten, wären großartig. (Vielleicht ist ein Hilfethema mit einer Codedatei verknüpft und kann Subversion prüfen, ob Änderungen vorgenommen wurden, und ein Thema als "möglicherweise veraltet" kennzeichnen ... träume ich?)
  • Der Inhalt der Hilfe kann lokalisiert werden.
  • Nicht im Gegensatz zu kommerziellen Produkt, aber eine kostenlose Option wäre nett.

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

    
Dave Mateer 04.06.2010, 20:04
quelle

6 Antworten

4

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

  • Besser als WYSIWYG über HTML: reStructuredText
  • Die Ausgabe an QtHelp (unter anderem), so wird es leicht sein, in unserer Anwendung zu verteilen (und zu integrieren).
  • Ich bin mir wegen Lokalisierung noch nicht sicher, aber wir werden diese Brücke überqueren, wenn wir müssen.
  • War einfach einzurichten und "funktioniert einfach"; sieht professionell aus.
Dave Mateer 09.06.2010, 13:52
quelle
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 an Word-Versionen binden, ist eine totale PITA (und hat mich gezwungen, MS-Office-Upgrades mehrmals zu vermeiden).

Wir bewegen uns zu einem madcap flare Ссылка

    
samjones 30.08.2010 00:20
quelle
2

Ich denke DocBook spricht alle Ihre Anforderungen an, außer vielleicht die Synchronisations-Hooks, über die ich noch weiter nachdenken werde. Es ist im Wesentlichen eine Teilmenge von XML, die zum Erstellen von Dokumentationen entwickelt wurde und frei und Open Source ist. Es ist nur ein Format plus eine Reihe von XSL-Ausgabetransformationen, die das Docbook in nützlichere Formate konvertieren (HTML und damit CHM, JavaHelp, PDF via XML-FO oder Tex).

Dies bedeutet, dass Sie immer noch ein XML-Authoring-Tool auswählen müssen, um es tatsächlich zu bearbeiten, damit Dinge wie WYSIWYG von den Funktionen Ihrer XML-Authoring-Software abhängen. Wir verwenden Syntext Serna, da es eine gute Unterstützung für WYSIWYG und Inline-Editing von XML # beinhaltet (niemand scheint letzteres zu unterstützen). Möglicherweise finden Sie andere XML-Authoring-Tools, die Ihren Anforderungen besser entsprechen - Serna ist ein kostengünstiges kommerzielles Angebot.

Docbook bietet eine große Flexibilität durch Profilerstellung, mit der Sie XML-Elemente basierend auf ihren Attributen ein- und ausschließen können. Ein Beispiel für einen Anwendungsfall wäre eine etwas andere Hilfeausgabe für OS = Windows als für OS = Linux. Die Lokalisierung wird auch durch Profiling und andere Mechanismen unterstützt.

Eine ziemlich gute Einführung in Docbook kann finden Sie hier .

Wir verwenden Docbook für unser Hilfeformat und kompilieren es in CHM-Dateien, die nur Hilfe für die für ein bestimmtes Produkt relevanten Funktionen enthalten (dh die Enterprise Edition verfügt über Funktionen, die nicht in der Standard- oder Demoversion enthalten sind). Die relevanten Schritte sind:

  1. Führen Sie die Profiling-XSL-Vorlagen in der XML-Quelle aus (z. B. mit XSLTproc).
  2. Führen Sie die HTML-Hilfe-XSL-Vorlagen auf der Ausgabe 1 aus.
  3. Kompilieren Sie die ausgegebenen HTML-Dateien mit dem HTML-Hilfe-Compiler (HHC) von Microsoft.
imoatama 30.08.2010 01:35
quelle
1

Hilfe & amp; Handbuch

    
Dave Mateer 04.06.2010 20:05
quelle
0

Robohelp

    
Dave Mateer 04.06.2010 20:04
quelle
0

Der einzige, den ich kenne, ist Latex, einer der latex2html-Konverter, und dann ein paar Anpassungen, um den resultierenden HTML-Code für den CHM-Archiver bereit zu machen.

  • Text, html, chm, pdf, ps kein Problem.
  • Die Konvertierung in Word über RTF war früher ein Desaster, ich kenne den aktuellen Status nicht.
  • latex 2 HTML-Konverter, während mehrere, alle haben ihre eigenen Probleme.
  • Die pdfs sehen absolut toll aus.
  • WYSIWYM (via lyx) möglich.

Dieses Archiv hat eine Reihe von CHMs (insbesondere die prog-, ref- und user-Teile, der Rest (rtl, fcl, lcl) wird durch unser eigenes doxygen-Äquivalent, fpdoc, generiert)

Ссылка

Beachten Sie, dass die obigen CHMs mit unserem eigenen (portablen) CHM-Compiler erstellt wurden. Ja, keine Werkstatt mehr.

Ein Lyx-Dokument als PDF und HTML:

pdf: Ссылка

html: Ссылка

    
Marco van de Voort 11.06.2010 12:11
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset In C # kann Auto-Eigenschaft einige zusätzliche Arbeit mit Hilfe eines Attributs ausführen?