Workflow-Turn Wiki Inhalt in ein Systemhandbuch

https://stackoverflow.com/questions/618508

wiki
manuals

03-07-2019
|

Frage

Wir sind in der Mitte zu viel von den Benutzern in viel von Orten (200+ Benutzer über 8 Länder) ein neues Softwaresystem bereitstellen. In der Vergangenheit haben wir ein Handbuch für den Benutzer geschrieben, es dann jeder so oft aktualisieren. Dies funktioniert ok, dass alle Benutzer ahve das gleiche Handbuch und es deckt die wichtigsten Dinge, aber es hat es Probleme gibt, wie es nicht so oft aktualisiert wird erhalten, wir Updates manchmal vermissen, und einige Benutzer alte Kopien haben.

Wir haben im Gespräch über ein Wiki während der Test- und Einführungsphase mit einer Wissensbasis über das System zu bauen. Im Idealfall, wie würden wir dann eine Möglichkeit, dass fo elektronisches Dokument in irgendeiner Form zu konvertieren, die dann können wir ‚pretty-fie‘ und als offizielle Handbuch auszusenden, sowie dass die Anwender verwenden und das Wiki aktualisieren.

Hat jemand etwas ähnliches getan? Irgendwelche Vorschläge für Wiki-Systeme, Workflows, Dokumentenformate etc?

Lösung

Die meisten Wikis Export via PDF z unterstützen.

Andere Tipps

Sie können etwas schreiben, das LaTeX aus dem Wiki und macht eine manuelle PDF. Mit Paketen wie hyperref Sie Querverweise als Hyperlinks behalten können.

Darüber hinaus können Sie Inhalte aus verschiedenen Quellen wie zum Beispiel ein Datenwörterbuch in das LaTeX-Dokument integrieren, die gemischt werden können und mit dem Wiki-Inhalte angepasst. Sie könnten auch die Architektur aufgebaut, so dass es Querverweise unterstützen, die in beiden Richtungen gehen.

Framemaker könnte auch dies mit generierten unterstützen MIF-Dateien, und Sie könnten auch a href = "http <: //lout.wiki.sourceforge.net/“rel = "nofollow noreferrer"> Lout in ähnlicher Weise oder wandeln Sie Ihre Wiki-Inhalte auf DocBook , die Sie erlauben würden, verwenden Sie einen der vielen Rendering-Optionen verfügbar auf dieses Format.

Als beiseite, die folgenden Nachrichten Stackoverflow für verschiedene Systeme diskutieren Dokumentation beibehalten wird.

MadCap Flare ist eine Hilfe-und-Hand-Authoring-Tool, das HTML für die verwendet Quelle jedes Thema. Man könnte ziemlich leicht eine Massenimport der Wiki-Seiten tun. Würde dann etwas Reinigung erfordern, aber nach, dass Sie haben ein schönes Single-Source-System für die Ausgabe CHM, Web-Hilfe mit Suchfunktion, PDF, DOC / DOCX, etc.

Wie speichern Sie die Hilfe Quelle im Moment? Ist es MS Word-Dateien, MS Hilfe, LaTeX?

Wenn Sie Ihre Hilfe Quelldateien unter Versionskontrolle gestellt, dann werden Sie alle Vorteile eines Wikis, ohne auf ein neues System zur Migration - Menschen leicht Änderungen an die Hilfedateien machen können - diese Änderungen verfolgt werden können, rückgängig gemacht usw. ., und Sie erhalten die prettified Handbücher wie zuvor.

folgte ich Knotens Links und stieß auf einige Mediawiki-Seiten, die ich dachte, waren bemerkenswert.

Ich habe eine vorherige Antwort die nützlich sein können für die „Wiki-PDF“ Teil - siehe die Open-Source PediaPress Code oder Funktionalität zu verwenden. Sie können auch ODFs von ihm erhalten, obwohl ihre PDFs schon recht hübsch sind (aber Sie könnten es Rebranding wollen und restyle es für Ihr Unternehmen nehme ich an).

Lizenziert unter: CC-BY-SA mit Zuschreibung

Nicht verbunden mit StackOverflow