(Created page with 'Each page to be included in the developer guide should include categories to enable people to find/group it, for example: * The fact it's a MeeGo Developer Guide page (dev-guide…') |
(categorise) |
||
| (4 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
Each page to be included in the developer guide should include categories to enable people to find/group it, for example: | Each page to be included in the developer guide should include categories to enable people to find/group it, for example: | ||
| - | * The fact it's a MeeGo | + | * The fact it's a MeeGo SDK documentation page (devguide) |
* MeeGo version it's applicable to (e.g. meego-1.0, meego-1.1, maybe even meego-1.0+) | * MeeGo version it's applicable to (e.g. meego-1.0, meego-1.1, maybe even meego-1.0+) | ||
* Documentation type (e.g. tutorial, use-case, recipe) | * Documentation type (e.g. tutorial, use-case, recipe) | ||
* Topic (e.g. media, ui-design, bluetooth, networking) | * Topic (e.g. media, ui-design, bluetooth, networking) | ||
| - | * Vertical to which it applies, if relevant (e.g. tv, netbook, mid) | + | * Vertical to which it applies (or "core"), if relevant (e.g. core, tv, netbook, mid) |
* Level (e.g. beginner, intermediate, advanced) | * Level (e.g. beginner, intermediate, advanced) | ||
* Language (e.g. c, c++, python, javascript) | * Language (e.g. c, c++, python, javascript) | ||
| Line 30: | Line 30: | ||
We don't have to have one navigation system, of course, but grouping the material like this gives people somewhere to start. | We don't have to have one navigation system, of course, but grouping the material like this gives people somewhere to start. | ||
| - | + | == Documentation types == | |
* Tutorials: Longer, narrative-based sets of instructions supporting a particular workflow. | * Tutorials: Longer, narrative-based sets of instructions supporting a particular workflow. | ||
* Recipes: shorter, less narrative, standalone sets of instructions to accomplish a particular goal. | * Recipes: shorter, less narrative, standalone sets of instructions to accomplish a particular goal. | ||
| + | |||
| + | [[Category:Devguide]] | ||
Each page to be included in the developer guide should include categories to enable people to find/group it, for example:
This gives several axes for slicing up the documentation. We'd probably want to use those categories to carve out some very high-level navigation, e.g.
We don't have to have one navigation system, of course, but grouping the material like this gives people somewhere to start.