Was ist ein gutes Werkzeug für das Schreiben ein Bedienungsanleitung (Hilfedatei), die mit der Versionskontrolle integriert [geschlossen]

StackOverflow https://stackoverflow.com/questions/152241

Frage

Die Leute, die Bedienungsanleitung zu schreiben sind nicht unbedingt Programmierer, und sie brauchen einen visuellen Editor. Ein wichtiges Thema ist das interne Format des Authoring-Tool; es sollte lesbarer Text / html sein, es ist so einfach Versionen einzelner Seiten in der Versionskontrolle überprüft zu vergleichen.

War es hilfreich?

Lösung

Es gibt andere professionelle Produkte, die Hilfedatei schreiben lassen und sie haben Unterstützung von „Kontext-ID“, die kontextsensitive Hilfe möglich macht. Doc Um Hilfe und RoboHelp sind diese Art von Produkten.

Andere Tipps

DocBook

“
(Quelle: docbook.org )

Microsoft HTML Help Workshop kann verwendet werden, um gute Qualität Dateien professionelle CHM-Hilfe zu erstellen. Alles, was Sie ist ein Bündel von HTML-Dateien benötigen. Das Tool „kompiliert“ all diese und Bündel in eine einzige Hilfedatei. Die HTML-Dateien können mit Microsoft Word / Frontpage oder sogar Dreamweaver erzeugt werden. Sie könnten Quelle steuert diese HTML-Dateien zu betrachten.

Latex . Lyx bietet WYSIWYM für Latex-Dateien geschrieben werden.

Bei meinem alten Job, den sie verwendet, um ein Werkzeug von MadCap Software namens Flare .

Es schien wirklich gut zu funktionieren.

Eine gute Kombination zu prüfen, ist Subversion, DocBook und Publican.

Im Moment ist dies eine der Werkzeugketten in der Nutzung durch die weltweit größten Anbieter von Open Source-Lösungen, und der Name hinter viel der Benutzung der Welt von Linux-basierten Betriebssystemen in dem Enterprise-Markt. Die meisten (und nah an allen) von Red Hat offizielle Dokumentation ist in einer solchen Art und Weise erzeugt. Das Gleiche gilt für Fedora.

Die große „pro“ hier ist, dass diese frei verfügbare Tools, mit einer starken Überlappung auf dem Markt der technischen Autoren. All das in der Lage zu werden (aber vielleicht nicht wollen) in XML schreiben und DocBook Aufnehmen ist wie HTML in den 90er Jahren aufnimmt. Subversion ist ein sehr häufiges Versionskontrollwerkzeug, das wie DocBook relativ einfach zu implementieren und zu nutzen. Publican ist ein großes Publishing-Tool, das DocBook XML nehmen kann, und veröffentlicht sie in PDF, HTML, HTML-Single, usw. Offensichtlich Ihre Autoren einen WYSIWYG wie Serna verwenden können, aber ich Schnipsel in Geany (auf Fedora) oder Textmate (auf OS X) persönlich.

Der größte „con“ ist die Wahrnehmung von Sache. Ihre Autoren möchten WYSIWYG (und kann es haben), und je nach Anforderungen an die Dokumentation, könnte dies sein, was Sie am Ende mit. Wie würden Sie wissen, gibt es einen Markt gibt für „Technische Redakteure“, die bei der Festsetzung der Microsoft Word-Formate spezialisiert sind (und Markup), so dass die Argumente für die Trennung „Authoring“ von „Publishing“ basieren auf bewährten, aber unterschiedliche Anwendungsfälle für Organisationen, die Nachweise verlangen nach den gleichen Standards der Technik / Programmierung / Quelle Produktion gehalten werden.

Einige der extremen Beratung werden Sie kommen von Menschen und Unternehmen erhalten, die auf den Wert von XML-Dokumentation ausgesetzt war, und vor allem in den Bereichen der DITA, in denen bestimmten multinationalen einen guten Ruf für Akquisitionen, die durch folgende Faktoren beeinflusst werden das Format und die Verfügbarkeit des Produktwissens. gibt es auch, dass die Argumente Ihre Dokumentation in ein „sticky“ oder geschlossene Format Sperren nicht helfen, die zukünftigen Wartungsanforderungen. Hier werden die Open-Source-Optionen Unterstützung auf Unternehmensebene gewinnen. Plus, natürlich, es ist kostenlos.

Sie können Subversion und MGTEK Hilfe Producer verwenden. Hilfe Producer macht Hilfedateien von Word-Dokumenten. TortoiseSVN kommt mit Skripten verschiedene Revisionen von Word-Dokumente zu vergleichen, in Word selbst (Word hat eine Version vergleichen Werkzeug).

Die Benutzer werden ein Diff-Tool möchten, dass die eine ähnelt in sie bearbeiten. Wenn sie nur etwas nicht-technischer Natur sind, DocBook oder Latex werden nicht funktionieren (ich habe meine Benutzer versucht, geben beide, und ich habe sogar versucht, Epic Editor als DocBook-Editor, der sehr teuer ist, aber hat nicht funktioniert sehr gut, nachdem alle). Das Festhalten an etwas, das sie wissen (Word) finden Sie viele Kopfschmerzen verhindern.

Ich war sehr zurückhaltend, diesen Weg zu zuerst zu gehen, weil ich wollte eine Lösung, die mehr ‚technisch perfekt‘ war, aber ich merkte, dass im Laufe der Zeit mit glücklich und produktiv Benutzern wichtiger war. Nur zu sagen, dass ich weiß, wo du herkommst, sondern versuchen, die Word Route - es funktioniert viel besser in der Praxis als all ‚reine‘ textbasierte Lösungen, die es gibt. Reguläre Benutzer nicht Markup basierte Bearbeitung möchten.

Wenn Sie Visual Studio verwenden, einen Blick auf Sandcastle nehmen - http://www.codeplex.com / Sandcastle .

Es gibt auch ein paar Tools, die Sie Sandburg Dateien bauen helfen, versuchen „Sandburg“ auf Codeplex zu suchen. Einer von ihnen ist Sandcastle Help File Builder ( http://www.codeplex.com/SHFB ), aber ich habe es nie benutzt, damit ich weiß nicht, ob technisch nicht versierte Benutzer damit zufrieden sein werden.

MadCap Flare ist das beste kommerzielle Werkzeug um. Geschrieben von dem Ex-Entwickler von Robodoc

Ich habe ein Dokumentationssystem namens Mandown ( Markdown / HTML / Javascript / dateibasierte relativ verknüpfte Dokumente für die Portabilität), die leicht unter Versionskontrolle gehen würde. Der visuelle Editor Teil würden Sie herausfinden, separat müssen - ich manchmal HTML-Kit , die zumindest eine Vorschaufunktion hat.

Siehe Was ist der beste Weg, um Software zu speichern, Dokumentation?

Hier ist ein weiteres Werkzeug zu überprüfen: Xilize

Wir verwenden APT . Es integriert sich gut mit dem CI (Standard Build Artefakt) und ist lebendiger als zum Beispiel Word-Dokument. Es ist auch möglich, PDF-Dateien und andere Formate zu erzeugen, wenn erforderlich.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top