Revision as of 07:32, 11 April 2011

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

• Taru Laine, Doc team lead: Organises meetings, follows and reports about the overall status of the documentation project.
• Elliot Smith: General content creation, editing and organisation.
• Ronan MacLaverty
• Murali Punaganti
• Bob Spencer
• Max Yu

Requirements for MeeGo 1.2 SDK documentation release

• On MeeGo roadmap page, you can follow MeeGo 1.2 product roadmaps. See SDK roadmap for viewing planned features.
• Developer documentation requirements are listed as MeeGo 1.2 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

• Status reports from documentation weekly meetings
• Status of individual pages is available in Documentation_Backlog_for_MeeGo_1.2

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

• Quality team tests all step-list instructions (Note that Quality team also creates draft material for documentation releases)

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 http://wiki.meego.com/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.