Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What tools does your team use for writing user manuals? [closed]

Basic requests are:

  • human readable / text format (for easy version control)
  • online (for collaboration)
  • easy formatting (markdown ok, html is too much)
  • strict formatting (so authors don't invent new types of titles, bullets etc.)
  • exportable to PDF, HTML
  • easy backup and deployment (so we can "deploy" to customers site as read only version)

We are thinking about using some kind of wiki engine, but it would need to use files for storage or have other means of "deployment" to customer and be easy to install/maintan. Also, it would have to be free / cheap (confluence is way too expensive)

Any suggestions?

Edit: I'm not looking for tools to document code, we have that covered using Sandcastle.

like image 748
David Vidmar Avatar asked Nov 24 '08 13:11

David Vidmar


People also ask

Which manuals is a user documentation?

User documentation (also called end user manuals, end user guides, instruction manuals, etc.) is the content you provide end users with to help them be more successful with your product or service.


2 Answers

LaTeX

like image 71
Irwin Avatar answered Sep 20 '22 21:09

Irwin


Although it may not answer all your requests, DokuWiki may be worth taking a look at.

As with other wikis, it has a simple syntax, and has version control to track revisions, generates table of contents, and a full-text search feature which can come handy for a help system.

You may want to evaluate the feature list to see if it will meet your needs.

Also, there seems to also be a good collection of avaialble plugins. Although I haven't used DokuWiki or its plugins, there seems to be plugins available for PDF export as well.

like image 33
coobird Avatar answered Sep 18 '22 21:09

coobird