What documentation system to use for user guide

Question

I'm currently trying to find a documentation (user guide) system that would have following features:

documentation files in text mode (so svn could diff/merge it)
possibility to use images, table, cross-references and table of contents
export to pdf (or .doc/.odt) that would support cross-references

I tried markdown for documentation source files and pandoc for pdf export but markdown does not support tables.

I really appreciate any help you can provide.

score 0 · Accepted Answer · answered Jul 01 '15 at 08:08

0

We use Sphinx for this scenario.

It can generate html, pdf and some other formats from reStructuredText Files.

And have a look at list-table when you want to add complex tables.

answered Jul 01 '15 at 08:08

Rudi

19,366
3
55
77

Seems very interesting, i will have a look on it. Thank you very much. – Nunux Developer Jul 01 '15 at 08:38

score 0 · Answer 2 · edited Apr 13 '17 at 12:34

0

I use the TeX for electonic and printable documentation

https://tex.stackexchange.com/

https://en.wikipedia.org/wiki/TeX

edited Apr 13 '17 at 12:34

Community

1
1

answered Jul 01 '15 at 08:58

Y.N

4,989
7
34
61

score 0 · Answer 3 · answered Jul 01 '15 at 15:08

0

Probably the most commonly used solution set for documentation is XML in Docbook or DITA. You can certainly manage those in SVN as well as perform diffs. They both provide processing toolchains with many output types include PDF through XSL FO.

answered Jul 01 '15 at 15:08

Kevin Brown

8,805
2
20
38

What documentation system to use for user guide

3 Answers3