Revision as of 14:14, 21 May 2010

A set of documentation principles describing the documentation process and the different licenses for different documents.

Developer Guide process

The intention behind the Developer Guide is to sign-post the most-accurate information available to MeeGo developers. As such, it should not be added to in an ad hoc fashion.

If you notice something missing from (or a bug in) the Developer Guide, you have a few options to resolve the issue:

• Fix it yourself (if it's already in the guide); let the meego-sdk mailing list know if it's anything significant (e.g. you removed or added a large chunk of text; fixing typos is OK and you don't need to tell anyone)
• Write a new page yourself and log a request to have it added to the Developer Guide; include the title of the page in the title of the bug
• Log an enhancement request for a page to be added to the Developer Guide if you can't or won't write it yourself
• Log the bug if you spot a problem on a page (something wrong, something missing) and can't or won't fix it yourself

Documentation issues should be attached to the appropriate version of the Developer Guide (corresponding to MeeGo versions): check the version of the Developer Guide you're viewing and select the appropriate version when making your request.

Once a page has been created, change the title of the bug (if you can) to reflect the title of the page it applies to. This just makes it a bit easier to visually link bugs to pages.

Content categorisation

We need to start applying some kind of categorisation system to make it easy to find documents relating to the backlog (see Developer guide content organisation for some suggestions).

Licensing

Creative Commons Attribution 3.0 is the licence for the wiki; documentation uses the same licence