Meego Wiki
Views

SDK/Documentation

From MeeGo wiki
< SDK(Difference between revisions)
Jump to: navigation, search
m (→Ways of working)
(→Requirements for MeeGo 1.3 SDK documentation release)
 
(28 intermediate revisions not shown)
Line 1: Line 1:
 +
'''* Information is currently being updated for MeeGo SDK 1.3 so some links may not be valid *'''
 +
= MeeGo SDK Documentation Team =
= 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.
+
== Scope and targets==
-
== Team members ==
+
MeeGo documentation team is a subteam of the MeeGo SDK team that is responsible for providing documentation about developing for MeeGo platform. The documentation work is planned, carried out, and finalized in sync with MeeGo SDK releases.
-
* Elliot Smith
+
== Team members ==
-
* Titta Väyrynen, Doc team lead. Organises meetings, follows and reports about the overall status of the documentation project.
+
* Marianne Vaiciulis
-
* Ronan MacLaverty
+
* Taru Laine
 +
* Elliot Smith 
* Murali Punaganti
* Murali Punaganti
* Bob Spencer
* Bob Spencer
 +
* Max Yu
 +
== Requirements for MeeGo 1.3 SDK documentation release==
-
== Ways of working ==
+
* On [[Roadmap|MeeGo roadmap page]], you can follow MeeGo 1.3 product roadmaps. See SDK roadmap for viewing planned features.
 +
* Developer documentation requirements are listed as MeeGo 1.3 SDK features in [http://bugs.meego.com/ Bugzilla]. To search for the developer documentation features, select ''Documentation'' as the '''Component''' in the search criteria.
 +
* [[Documentation_Backlog_for_MeeGo_1.2 | Documentation_Backlog_for_MeeGo_1.2]] functions as a backlog for following the MeeGo 1.2 documentation requirements, responsibilities, and status of individual pages.
-
===Organizing wiki content===
+
== Status summaries ==
-
To allow archiving content for previous releases as well as finding any new content conveniently, we plan to organize the pages as follows:
+
* [[SDK/Meetings#Weekly_meetings | Status reports from documentation weekly meetings]]
-
* Categorize everything for MeeGo 1.1 release with wiki category 'MeeGo 1.1'
+
* Status of individual pages is available in [[Documentation_Backlog_for_MeeGo_1.2 | Documentation_Backlog_for_MeeGo_1.2]]
-
* 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 ===
+
== Milestones and schedules ==
-
Currently, content planning is carried out in wiki.meego.com: [http://wiki.meego.com/Application_developer_site/Draft_content 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.  
+
Documentation work is planned, carried out, and finalized in sync with MeeGo SDK releases (See [[SDK/Release|Release page]] for current status information.). Work on individual documentation tasks is started as soon as the implementation related to that specific area is on a reasonable level.
-
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.
+
== Risks ==
 +
 
 +
== Quality plan ==
 +
 
 +
* [[Quality| Quality team]] tests all step-list instructions (Note that Quality team also creates [[SDK/Docs/1.2-preview-under-progress|draft material]] for documentation releases)
=== Reviews and content verification===
=== Reviews and content verification===
Line 39: Line 45:
//More information about testing and review process to be added, later.//
//More information about testing and review process to be added, later.//
-
== MeeGo 1.1 SDK documentation release ==
 
-
=== Planning and status ===
+
== Maintenance plan ==
 +
 
 +
Work related to the current release is prioritized over maintenance work, but the team also follows documentation-related bugs in Bugzilla.
 +
Currently, Elliot Smith manages this task.
 +
 
 +
== Ways of working - instructions for documentation team members ==
 +
 
 +
===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 x.y release with wiki category 'Meego-x.y'
 +
* Create all new draft pages for the MeeGo x.y release under the name space http://wiki.meego.com/SDK/Docs/x.y
 +
: (For example, http://wiki.meego.com/SDK/Docs/1.1/Getting_started_with_MeeGo_SDK)
 +
* Link the developer guide for MeeGo x.y to the [[SDK/Docs|SDK docs overview page]]
 +
* The links to the Getting Started guides for Windows and Linux should always point to the latest (released) MeeGo version
 +
 
 +
===Publishing wiki content===
 +
 
 +
Developer documentation for MeeGo SDK is created and reviewed in wiki.meego.com. When the documentation of a new MeeGo SDK release has been approved for publishing, the wiki content is migrated to the actual publishing sites. The main publishing channel for the MeeGo SDK documentation is the developer.meego.com (DMC) site.
 +
 
 +
When the MeeGo SDK release is ready, the documentation for the new release is added to the DMC site. The developer documentation for the previous releases will only be available through [[SDK/Docs]]. For the suggested publishing locations of each section of the MeeGo 1.2 SDK developer library, refer to the Documentation backlog.
 +
 
 +
For community members (with no editor privileges for the DMC site), the process for updating published developer documentation is the following:
 +
* Community member creates the content in wiki.
 +
* Community member creates a bug in Bugzilla.
 +
* Content editor checks the content and suggest improvements, if necessary.
 +
* Content editor transfers the content to DMC site.
 +
 
 +
The responsibilities and processes related to the DMC site are explained [[Application_developer_site |in this section]]. The future ownership for developer.meego.com still needs to be further clarified.
 +
 
 +
== Ways of working - instructions for community contribution ==
 +
 
 +
//add information, possible templates and helpful instructions on how community can participate in documentation work!//
 +
 
 +
== Information about earlier releases ==
-
This section will later include a backlog for following the MeeGo 1.1 documentation requirements and status.
+
=== Requirements for MeeGo 1.1 SDK documentation release===
-
+
-
Release planning is ongoing. Content areas and their owners are listed below:
+
-
=== Content areas ===
+
For MeeGo 1.1 release:
-
* '''Terminology/glossary''' (Titta)
+
* 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.
-
**  fix the term for SDK ( MeeGo SDK?)
+
* [[Developer_Guide_for_MeeGo_1.1]] functions as a backlog for following the MeeGo 1.1 documentation requirements, responsibilities, and status of individual pages.
-
* '''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)
+
-
** draft exists, to be approved http://wiki.meego.com/Application_developer_site/Draft_content/Community
+
-
* '''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 [http://meego.com/developers/ui-design-guidelines/handset 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)
+

Latest revision as of 15:46, 8 June 2011

* Information is currently being updated for MeeGo SDK 1.3 so some links may not be valid *

Contents

MeeGo SDK Documentation Team

Scope and targets

MeeGo documentation team is a subteam of the MeeGo SDK team that is responsible for providing documentation about developing for MeeGo platform. The documentation work is planned, carried out, and finalized in sync with MeeGo SDK releases.

Team members

  • Marianne Vaiciulis
  • Taru Laine
  • Elliot Smith
  • Murali Punaganti
  • Bob Spencer
  • Max Yu

Requirements for MeeGo 1.3 SDK documentation release

  • On MeeGo roadmap page, you can follow MeeGo 1.3 product roadmaps. See SDK roadmap for viewing planned features.
  • Developer documentation requirements are listed as MeeGo 1.3 SDK features in Bugzilla. To search for the developer documentation features, select Documentation as the Component in the search criteria.
  • Documentation_Backlog_for_MeeGo_1.2 functions as a backlog for following the MeeGo 1.2 documentation requirements, responsibilities, and status of individual pages.

Status summaries

Milestones and schedules

Documentation work is planned, carried out, and finalized in sync with MeeGo SDK releases (See Release page for current status information.). Work on individual documentation tasks is started as soon as the implementation related to that specific area is on a reasonable level.

Risks

Quality plan

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.//


Maintenance plan

Work related to the current release is prioritized over maintenance work, but the team also follows documentation-related bugs in Bugzilla. Currently, Elliot Smith manages this task.

Ways of working - instructions for documentation team members

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 x.y release with wiki category 'Meego-x.y'
  • Create all new draft pages for the MeeGo x.y release under the name space http://wiki.meego.com/SDK/Docs/x.y
(For example, http://wiki.meego.com/SDK/Docs/1.1/Getting_started_with_MeeGo_SDK)
  • Link the developer guide for MeeGo x.y to the SDK docs overview page
  • The links to the Getting Started guides for Windows and Linux should always point to the latest (released) MeeGo version

Publishing wiki content

Developer documentation for MeeGo SDK is created and reviewed in wiki.meego.com. When the documentation of a new MeeGo SDK release has been approved for publishing, the wiki content is migrated to the actual publishing sites. The main publishing channel for the MeeGo SDK documentation is the developer.meego.com (DMC) site.

When the MeeGo SDK release is ready, the documentation for the new release is added to the DMC site. The developer documentation for the previous releases will only be available through SDK/Docs. For the suggested publishing locations of each section of the MeeGo 1.2 SDK developer library, refer to the Documentation backlog.

For community members (with no editor privileges for the DMC site), the process for updating published developer documentation is the following:

  • Community member creates the content in wiki.
  • Community member creates a bug in Bugzilla.
  • Content editor checks the content and suggest improvements, if necessary.
  • Content editor transfers the content to DMC site.

The responsibilities and processes related to the DMC site are explained in this section. The future ownership for developer.meego.com still needs to be further clarified.

Ways of working - instructions for community contribution

//add information, possible templates and helpful instructions on how community can participate in documentation work!//

Information about earlier releases

Requirements for MeeGo 1.1 SDK documentation release

For MeeGo 1.1 release:

  • 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.
  • Developer_Guide_for_MeeGo_1.1 functions as a backlog for following the MeeGo 1.1 documentation requirements, responsibilities, and status of individual pages.
Retrieved from "http://wiki.meego.com/SDK/Documentation"
Personal tools