Workflow for turning Wiki content into a system guide

Question

We are in the middle of deploying a new software system for a large number of users in many places (more than 200 users in more than 8 countries). In the past, we wrote a user guide and then updated it so often. This works fine, since all users have the same manual, and it covers the main things, but it has problems, for example, that it does not update, that often we sometimes skip updates, and some users will have old copies.

We talked about using the wiki in the testing and deployment phases to create a knowledge base about the system. Ideally, we would like to somehow convert this into some form of electronic document, which we can then “pretty-fi” and send as an official guide, and also allow users to use and update the wiki.

Has anyone else done something like this? Any suggestions for wikis, workflows, document formats, etc.

Answer 1

Support for exporting wikis via PDF, for example:

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

Answer 2

You can write something that LaTeX generates from the wiki and prints the manual in PDF. With packages like hyperref , you can save cross-references as hyperlinks.

In addition, you can integrate content from multiple sources, such as a data dictionary, into a LaTeX document that you can mix and match with wiki content. You can also customize the architecture to support cross-references that go anyway.

Framemaker can also support this using the generated MIF , and you can also use Lout in the same way or convert your wiki content to a docbook, which allows you to use any of the many rendering options available for this format.

As an aside, the following Stackoverflow publications discuss various documentation systems.

• An application (not a markup language) for creating a user guide

• Can LaTeX be used to create any documentation that comes with the software?

• What tools are used to write documentation?

• What tools does your team use to write user manuals?

• What is the best way to write documentation (ideally in latex), oriented both to web (html) and paper (pdf)?

• Best DocBook XML Document Tool?

• What is the recommended toolbar for formatting XML DocBook?

• Is the successor to TeX / LaTeX in sight?

Answer 3

Madcap Flare is a help and guidance tool that uses HTML to source each topic. You can pretty easily do bulk import of Wiki pages. Then it will take some cleanup, but after that you have a good single source system that can output CHM, web browser help, PDF, DOC / DOCX, etc.

Answer 4

How do you store the help source at the moment? Are these MS Word files, MS help, LaTeX?

If you put your source help files under version control, you will get all the benefits of the wiki without having to switch to a new system - people can easily edit help files - these changes can be tracked, canceled, etc. .. and you will get ready-made guides, like before.

Answer 5

I followed the Node links and came across some mediawiki pages that I thought were worthy of attention.

• Extension: OpenDocument Export
• Extension: PDF Writer
• Category: Data Extensions

Answer 6

I gave the previous answer , which may be useful for the "wiki to PDF" part - look at the use of the open source code or functions of PediaPress. You can also get ODFs from them, although their PDF files are already pretty good (but you might want to refinance them and remake them for your company).