Workflow pour transformer le contenu Wiki en un manuel système

Question

Nous sommes en train de déployer un nouveau système logiciel pour beaucoup d'utilisateurs dans beaucoup d'endroits (plus de 200 utilisateurs dans 8 pays). Dans le passé, nous avons écrit un manuel pour les utilisateurs, puis le mettre à jour de temps en temps. Cela fonctionne bien, dans la mesure où tous les utilisateurs ont le même manuel et il couvre les principales choses mais il a ses problèmes, comme il ne se met pas à jour souvent, nous manquons parfois des mises à jour, et certains utilisateurs ont des anciennes copies.

Nous avons parlé d'utiliser un wiki pendant les phases de test et de déploiement pour construire une base de connaissances sur le système. Idéalement, nous aimerions alors pouvoir convertir cela en une forme de document électronique que nous pourrons ensuite utiliser comme un manuel officiel, tout en laissant les utilisateurs utiliser et mettre à jour le wiki.

Est-ce que quelqu'un d'autre a fait quelque chose de similaire? Des suggestions pour les systèmes wiki, les workflows, les formats de document, etc.?

Answer 1

La plupart des wikis prennent en charge l'exportation via PDF .: par exemple

• MediaWiki PDF Export
• DokuWiki PDF Export
• TWiki PDF Export

Answer 2

Comment entreposez-vous la source d'aide au moment? Est-ce que ce sont des fichiers MS Word, MS help, LaTeX? Si vous placez vos fichiers source d'aide sous contrôle de version, vous obtiendrez tous les avantages d'un wiki sans avoir à migrer vers un nouveau système - les utilisateurs peuvent modifier facilement les fichiers d'aide - ces changements peuvent être suivis, annulés etc. et vous obtenez les manuels prétendu comme avant.

Answer 3

Vous pouvez écrire quelque chose qui génère LaTeX à partir du wiki et qui rend un manuel au format PDF. Avec des packages tels que hyperref, vous pouvez conserver des références croisées sous forme de liens hypertexte. En outre, vous pouvez intégrer du contenu de plusieurs sources, tel qu'un dictionnaire de données, dans le document LaTeX, qui peut être mélangé et associé au contenu du wiki. Vous pouvez également configurer l'architecture pour qu'elle puisse prendre en charge les références croisées dans les deux cas.

Framemaker pourrait soutenir également cette utilisant généré MIF fichiers, et vous pouvez également utiliser Lout d'une manière similaire ou de convertir le contenu de votre wiki pour docbook, qui vous permettra d'utiliser l'une des nombreuses options de rendu disponibles à ce format. En outre, les publications Stackoverflow suivantes traitent de divers systèmes de gestion de la documentation.

• Application (Not a Markup Language) for Producing a User Manual

• Can LaTeX be used for producing any documentation that accompanies software?

• What tools are used to write documentation?

• What tools does your team use for writing user manuals?

• How best to write documentation (ideally in latex) targeting both the web (html) and paper (pdf)?

• Best tool(s) for working with DocBook XML documents?

• What is the recommended toolchain for formatting XML DocBook?

• Is a successor for TeX/LaTeX in sight?

Answer 4

J'ai suivi les liens de nœud et suis tombé sur quelques pages mediawiki que je pensais était digne de mention.

• Extension:OpenDocument Export
• Extension:PDF Writer
• Category:Data extraction extensions

Answer 5

Madcap Flare est un outil de création de l'aide et manuelle qui utilise HTML pour la source de chaque sujet. Vous pouvez facilement faire une importation en masse des pages Wiki. Cela nécessiterait un peu de nettoyage, mais après cela, vous aurez un bon système à source unique qui peut générer des fichiers CHM, PDF, DOC/DOCX, etc ...

Answer 6

J'ai donné un previous answer qui peut être utile pour le "wiki" à PDF "partie - regardez à l'aide du code ou de la fonctionnalité PediaPress open source. Vous pouvez également obtenir des fichiers ODF, bien que leurs fichiers PDF soient déjà assez jolis (mais vous pourriez vouloir le renommer et le redéfinir pour votre entreprise, je suppose).