SDK/Documentation guidelines

Revision as of 21:24, 27 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 or subjected to massive restructurings without community involvement. Usual MeeGo SDK community channels can be used to discuss changes.

If you notice an improvement which could be made to the Developer Guide, you have a few options:

• 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 etc.)
• 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; be as specific as you can about the content you expect to see in it
• Log a bug if you spot a problem on a page (something wrong, something missing) and can't or won't fix it yourself; requests to remove a page, move a page out of the guide etc. can also be made this way

Bugs and enhancement requests are logged on http://bugs.meego.com/, inside the Documentation product, SDK docs component.

• Create a request for documentation
• Current open SDK docs bugs

Documentation issues should also 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.

Picking up documentation tasks

Documentation bugs can be taken on by any MeeGo SDK community member. Please review the SDK_Tutorial_Content page when authoring new content.

Bugs are closed at the discretion of the MeeGo SDK community; for example:

• A request for a new page can be closed when a page is in place which satisifies the requirements specified in the bug.
• A request to include a new page in the Developer Guide can be closed when the page is linked from the Developer Guide table of contents.

Content categorization

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