PDA

View Full Version : Which documentation system to use



ZuLuuuuuu
April 4th, 2009, 09:16 AM
Hello,

After completing a program, or during the development process I need to write some documentation, like tutorials, manual etc... I want to write a simple text file and then want it to be converted into HTML, PDF and CHM automatically. Which documentation system do you suggest as the best option?

Arndt
April 4th, 2009, 10:13 AM
Hello,

After completing a program, or during the development process I need to write some documentation, like tutorials, manual etc... I want to write a simple text file and then want it to be converted into HTML, PDF and CHM automatically. Which documentation system do you suggest as the best option?

Look at texinfo.

ZuLuuuuuu
April 4th, 2009, 10:44 AM
Look at texinfo.

Does not have Windows binaries, I guess? It might be a problem.

I found 3 options so far: Texinfo, Doxygen and POD (Plain Old Documentation) but I would like to hear the advantages/disadvantages from the users of these.

Note: I included POD because I know some Perl. So, documentation systems for other languages like Python or Ruby are not for me.

I have one more question: When I look at some plain text documentations, I see that the lines are wrapped so that they don't exceed 80 character width. Is there an easy way to do wrapping automatically while you are writing or do they do this manually? If they do this manually then isn't that hard to change all the wrapping when for example you decided to remove a sentence or even a word etc?

hessiess
April 4th, 2009, 10:58 AM
Doxygen is reasnable, but it produces terrable HTML.

Arndt
April 4th, 2009, 01:35 PM
I have one more question: When I look at some plain text documentations, I see that the lines are wrapped so that they don't exceed 80 character width. Is there an easy way to do wrapping automatically while you are writing or do they do this manually? If they do this manually then isn't that hard to change all the wrapping when for example you decided to remove a sentence or even a word etc?

I write text in Emacs, and there are practical commands to restore the
justification of the text. M-q, for example, rejustifies the current paragraph.

There is probably an Emacs mode to do automatic wrapping, but I don't use it; I press Return (or Linefeed) when needed.

(I think "justify" is not the word I want, because I don't necessarily mean straight right-edge margins, but it will serve.)