Tools to write documentation for the lazy guy?

kokoko3k · 2012-06-13 12:47:11

Hi all, from some years i'm developing a graphical project, but i've never had the will to write the documentation.
...what a boring task.
But now that i think my project is quite complete and stable, the time has come.

What tools do you suggest? There are a lot of functions,menues,checkboxes and so on to write about, so the natural end would be an hypertext with images.

Any advice for the task?

Thanks!

drcouzelis · 2012-06-13 13:48:32

It depends. What kind of application did you make and which what toolkit and what kind of documentation would you like to provide?

I wrote an application using wxWidgets, which includes a "Help Window" widget that just displays an HTML string. That made it super easy to provide graphical in-application help.

I wrote a couple of man pages (like for packer). I think those are kind of fun to make. I simply did an Internet search for "how to make a man page" or something. It was pretty easy to learn.

kokoko3k wrote:

from some years i'm developing a graphical project, but i've never had the will to write the documentation. ...what a boring task.

Some people find programming boring and writing documentation to be an enjoyable contribution. If you release your program and people like it someone might write the documentation for you.

Mr.Elendig · 2012-06-13 13:51:56

http://sphinx.pocoo.org/index.html

kokoko3k · 2012-06-13 14:42:45

@drcouzelis:
It's a mediaplayer written in Gambas/qt4:
https://aur.archlinux.org/packages.php?ID=54473
The documentation i'd like to write is intended for the end user, no man pages, no contextual (it is yet full of tooltips).

@Mr.Elendig:
Thanks, i'll give it a look

mloskot · 2012-06-13 20:13:38

kokoko3k wrote:

...what a boring task.
(...)
Any advice for the task?

Perhaps this will inspire: Documentation is freaking awesome

Arch Linux

#1 2012-06-13 12:47:11

Tools to write documentation for the lazy guy?

#2 2012-06-13 13:48:32

Re: Tools to write documentation for the lazy guy?

#3 2012-06-13 13:51:56

Re: Tools to write documentation for the lazy guy?

#4 2012-06-13 14:42:45

Re: Tools to write documentation for the lazy guy?

#5 2012-06-13 20:13:38

Re: Tools to write documentation for the lazy guy?

Board footer