Meego Wiki
Views

SDK/Documentation guidelines

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
A set of documentation principles describing the documentation process and the different licenses for different documents.
A set of documentation principles describing the documentation process and the different licenses for different documents.
-
 
-
= Licensing =
 
-
 
-
Creative Commons Attribution 3.0 is the licence for the wiki; documentation uses the same licence
 
= Developer Guide process =
= Developer Guide process =
Line 20: Line 16:
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).
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

Revision as of 13:31, 21 May 2010

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

Developer Guide process

The Developer Guide is a way to navigate the most-accurate information available to MeeGo developers.

If you notice something missing from (or a bug in) the Developer Guide, you have a couple of 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)
  • Log an enhancement request in http://bugs.meego.com/ for it to be added to/fixed in the Developer Guide (in the Documentation product, SDK docs)
  • Write a new page yourself and log a request on http://bugs.meego.com/ to have it added to the Developer Guide

Documentation issues can also be attached to appropriate MeeGo versions: check the version of the Developer Guide you're viewing and select the appropriate version from the list.

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

Retrieved from "http://wiki.meego.com/SDK/Documentation_guidelines"
Personal tools