Re: Documentation

[Mark Galassi <rosalia cygnus com>]

    adam> So I'm sitting here, trying to think of how I can make
    adam> myself usefull to the Gnome world.. (beyond getting off my
    adam> lazy bum and updating GnomeMaker :P) and decided the best
    adam> bet was to write some documentation.

You are dead right.

    adam> What needs documenting the most?  The various Gnome API's?
    adam> Specific programs?

The APIs are the most urgent, since the programs tend to be
user-friendly.

    adam> Is there allready a "Gnome Documentation Project" that flew
    adam> right by me?

There are a few stabs, which are getting better.  The web page lists
some intro docs and FAQs.  The GNOME Help Browser offers my "intro to
GNOME" which is quite outdated (I wrote it in May), but does give a
quick tour of applications and applets that were available back then.

But recently Federico proposed a documentation framework which
organizes docs for all aspects of GNOME, and Miguel proposed a way of
describing API functions within C comments placed right before the
function's code.  Both were well-received, and I guess they launch the 
'GNOME documentation project"!

I recommend you go through those messages carefully and see how you
might want to start filling out the doc framework.  Let me know if you 
need help with setting up the DocBook files.

Both messages are less than a couple of weeks old, and I can resend
them to you if you want.