[MeeGo-SDK] SDK documentation system

[Jeremiah Foster]

On Mar 5, 2010, at 12:59 PM, Adrian Yanes wrote:
> 
> In my opinion, one of the most common failure in documentation and
> open source projects is that we use a doc systems easy to maintain for
> developers and easy to check for users, but sometimes we loose the
> "control" of them. When the project is very big , always a lot of
> people start asking about "a book" or "official manual", and this
> involves more consistent information ( the wikis can be tedious when
> we are talking about a lot of doc).
> 
> It would very nice to prevent this kind of "error" and start to think
> now in what type of doc system we have to use. To document the SDK.
> 
> Something like docbook (http://docbook.org/) would be a nice choice.
> 
> What do you think?

I think it is a common 'best practice' to have the wiki be 'canonical', as Quim said, the master and most official document. This is certainly what I prefer as a developer since that is the way that most projects do it and what I am used to.

Jeremiah
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.meego.com/pipermail/meego-sdk/attachments/20100305/fc3d429b/attachment-0003.html>