Developer guide content organization

Revision as of 16:16, 16 September 2010

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 SDK documentation page (devguide)
• 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)
• Topic (e.g. media, ui-design, bluetooth, networking)
• Vertical to which it applies (or "core"), if relevant (e.g. core, tv, netbook, mid)
• Level (e.g. beginner, intermediate, advanced)
• Language (e.g. c, c++, python, javascript)
• Audience (e.g. platform-developer, application-developer)

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.

• MeeGo 1.0
  • Platform developer
    • Tutorials
    • Cookbook
  • Application developer
    • Tutorials
    • Cookbook
• MeeGo 1.1
  • Platform developer
    • Tutorials
    • Cookbook
  • Application developer
    • Tutorials
    • Cookbook
• etc.

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.
• Recipes: shorter, less narrative, standalone sets of instructions to accomplish a particular goal.