[OGo-Documentation] developer documentation

[Adam Tauno WIlliams]

> I'd also think, the document should start with an introductional chapter on 
> debugging ogo using gdb. So with my little knowledge, I would suggest, 
> starting there. When I have this, then I'd go on, explaining all the neat 
> enhancements I've done over the past, the AsteriskDialer plugin, the 
> AsteriskUI, some enhancements on the Chat-page in Misc, stuff like that.
> For these modules, I thought, explaining each in one chapter, directory 
> structure layout, GNUmakefiles, *plist files, and in the end how the 
> objective-c and webobjects are working together to get the module used in 
> the WebUI. 

Doesn't sound bad;  I'd just make sure we don't start to create an
Objective-C developers guide, etc...  Narrow and focused is good
sticking to stuff that isn't already documented elsewhere.

> While I was just fiddling around with the AsteriskDialer, I'd start with 
> explaining how I added that piece.
> But be warned, all my knowledge on how OGo is working internally, is just 
> from reading docs and sources, asking here on the mailing lists, and making 
> assumptions and guesses out of findings. So there will be errors and piece 
> missing, that I just don't know (better).

Same here;  if there was documentation I would have read it. :)

> Before that, some questions should be clarified:
> * Just start with a *txt file, to get it fast working, or better from the 
> beginning using a odf file?

Certainly would work.  Text is easy enough to pull into anything.

> * In case of *odf file, Adam, do you have an empty one, that you use for the 
> admin and users docs, but with all the styles already in there? I'd suggest 
> that these documents should look similar.

I just use the default ones; if you link the document into an ODM the
styles are easy enough to change globally.  The most import thing is to
use headers 1 ,2, 3, etc... so you can automatically build a useful
table of contents.  Second is to keep a list of keep terms and the like
so it can be added to the index.