Meego Wiki
Views

SDK/Documentation

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
(→Content areas)
m (→Ways of working)
Line 14: Line 14:
== Ways of working ==
== Ways of working ==
 +
===Organizing wiki content===
 +
 +
To allow archiving content for previous releases as well as finding any new content conveniently, we plan to organize the pages as follows:
 +
* Categorize everything for MeeGo 1.1 release with wiki category 'MeeGo 1.1'
 +
* Create all new draft pages for the MeeGo 1.1 release under the name space http://wiki.meego.com/SDK/Docs/1.1
 +
: (For example, http://wiki.meego.com/SDK/Docs/1.1/Getting_started_with_MeeGo_SDK)
 +
* Move any pages currently being updated under http://wiki.meego.com/SDK/Docs/1.1
 +
* (Later or when possible) Archive old existing pages that are not updated now under http://wiki.meego.com/SDK/Docs/1.0 and categorize them with wiki category 'MeeGo 1.0'
=== Backlog ===
=== Backlog ===

Revision as of 12:09, 15 October 2010

Contents

MeeGo SDK Documentation Team

MeeGo documentation team is a subteam of the MeeGo SDK team. The MeeGo SDK Documentation Team is responsible of providing documentation about developing for MeeGo platform.

Team members

  • Elliot Smith
  • Titta Väyrynen, Doc team lead. Organises meetings, follows and reports about the overall status of the documentation project.
  • Ronan MacLaverty
  • Murali Punaganti
  • Bob Spencer


Ways of working

Organizing wiki content

To allow archiving content for previous releases as well as finding any new content conveniently, we plan to organize the pages as follows:

  • Categorize everything for MeeGo 1.1 release with wiki category 'MeeGo 1.1'
  • Create all new draft pages for the MeeGo 1.1 release under the name space http://wiki.meego.com/SDK/Docs/1.1
(For example, http://wiki.meego.com/SDK/Docs/1.1/Getting_started_with_MeeGo_SDK)

Backlog

Currently, content planning is carried out in wiki.meego.com: Information structure. Note that the plan is subject to change.

For MeeGo 1.2 release, documentation team will move to using Bugzilla/Featurezilla in tracking release content.

Release content was initially divided into content areas, each with an owner. Content area owners are responsible for planning the content needs of their area.

Reviews and content verification

A buffer of two weeks before a release must be reserved for:

  • arranging content reviews
  • testing all instructions
  • finalizing the content based on received comments

//More information about testing and review process to be added, later.//

MeeGo 1.1 SDK documentation release

Planning and status

This section will later include a backlog for following the MeeGo 1.1 documentation requirements and status.

Release planning is ongoing. Content areas and their owners are listed below:

Content areas

  • Terminology/glossary (Titta)
    • fix the term for SDK ( MeeGo SDK?)
  • Release overview, description of the developer offering (Ronan)
    • introduces release content and what it offers developers
    • How to explain the native vs. web side?
  • Overview of MeeGo websites and their purpose (Ronan)
  • Setup/Getting started instructions for application developers (Bob, Veli)
    • from installation to first app
    • Bob has some material that he will review with Veli.
    • Titta assigned a writer to work on this for Linux on Wed 13.10.
    • Windows installer available soonish (Elliot working on win content)
    • Elliot is also working on WRT -related instructions
  • Other tool instructions (e.g. linking to information on Qt tools, MADDE, MAD-Developer, packaging tools, OBS use (doublecheck with Ville and Maurice), performance tools, WRT tools) (Elliot)
  • Architecture overview (Titta)
    • Sunil / Arjan and Sakari updating. Representation changing.
    • Titta: Initial idea on how the changes affect the API reference site drafted. I'm following the discussions on architecture team side.
    • Bob/Mike to help with adding content to meego.com
  • API reference and API overview :
    • Qt 4.7, Qt mobility 1.0, Meego Touch (MTF), OpenGL ES 1.1, 2.0 - review end of wk 41 (Murali Punaganti)
    • WRT (no owner, yet?) Delivered via Forum Nokia and we just point to the info.
    • "MeeGo Advanced API" (platform API): gstreamer, pulseaudio (Murali and Bob to discuss what is needed)
    • look-and-feel to be tested with Drupal site
    • Need to follow-up on platform API. How will it be presented.
  • UI guidelines
    • Elliot: I verified with the design team in the UK that the design guidelines for handset are current and valid; they were written by Nokia and are the basis of the reference handset UX design. No similar guidelines for netbook are planned. Darren Wilson is the contact from Intel, based in the UK office. I can send his email out by request.
    • Content to be moved to developer.meego.com.
    • Find a new owner for this content?
  • Samples (Elliot and Kerry Jiang (PRC SDK mgr))
    • Existing hello world level examples for Qt, Qt mobility, MeeGo Touch, and WRT)
  • Release notes (Veli, Bob)
Retrieved from "http://wiki.meego.com/SDK/Documentation"
Personal tools