How to get started on documentation for a project?



I've just joined this list, so please be patient if this has already
been discussed.

Its time for me to write some documentation for my project (gramps - a
genealogy program written in python/GNOME/libglade), so I am looking to
get started. I've looked at the gdp-handbook, and I don't think the
docbook format is going to be difficult to deal with.

I've found plenty of information about how to write in docbook, but not
much on how to set up a project to integrate and install the
documentation on a system. I tried to determine what to do by looking at
how the GNOME documentation is installed on my system (RH7.1, Ximian
Gnome). It seems a bit confusing, with some documents bringing up
mozilla (FAQ), others bringing up the gnome help browser (user's guide),
and other documentation in nautilus. This, along with references to
Scrollkeeper and OMF have me a bit confused. The gdp-handbook tells me
to turn the document over to the project maintainer, but that is me :-)

Is there any information on the correct way to set up a project to build
and install the documentation for a project? 

-- 
Don Allingham
dallingham users sourceforge net
http://gramps.sourceforge.net
GPG/PGP Public Key at
http://members.home.net/donaldallingham/dallingham.key





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]