|
|
|
|
|
|
|
|
|
MSF for CMMI Process Improvement > Wiki Pages > Activity - Create Documentation Plan
|
Activity - Create Documentation Plan
|
|
|
|
|
|
Activity Information Create Documentation Plan
DescriptionA documentation plan allows you to publish all of the details about the documentation, including planned content, format, scheduling, and resources, to the team so the documentation plans can be aligned with the product plans and agreed upon by the entire team before you start writing. Attributes| Element Categories | [CMMI Level 2] GG GP 2.2, [CMMI Track 5] Deploy | | Entry Criteria | Documentation Outlines:
Outlines are approved for all planned documentation deliverables.
Personas:
Personas are complete.
Scenarios:
Scenarios exist that describe the key user experience scenarios.
Iteration Plan:
Iteration plan for the product is complete.
Complete Functional Specifications:
Functional specifications are complete and provide details on the intended user experience. | | Exit Criteria | Documentation plan complete:
Documentation plan complete.
Project style guide is available:
Project style guide is available. | | Is Required | Yes |
StepsEstimate Resources and Schedule:
From the documentation outlines, determine the amount of work required to create the product documentation.
Estimate the resources required to complete the work.
Determine what resources are available to complete the work.
Map documentation deliverables to milestones on the iteration plan.
Develop an estimated documentation schedule. Determine Documentation Deliverables:
Choose a release format.
Decide on deliverables (work products).
Choose documentation template.
Create a project style guide and terminology list. Write Documentation Plan:
Provide schedule and resource estimates for the documentation project.
If art will be developed, provide resource needs and art estimates.
If documentation will be localized into other languages, provide information on schedule and resources needed.
Identify reviewers who will participate in the peer review.
Summarize the constraints, assumptions, and dependencies for the documentation project.
Include documentation outlines, along with the planned delivery format, and pointers to documentation templates and the project style guide. Get sign-off on the documentation plan from the team:
Hold a meeting to discuss planned documentation deliverables.
Send the documentation plan to key project stakeholders.
Provide a deadline for comments.
Incorporate review comments and publish final documentation plan to project portal.
|
Last modified at 12/19/2007 10:37 AM by Administrator
|
|
|
|
 |
|
|
|
|