|
|
|
|
|
|
|
|
|
MSF for CMMI Process Improvement > Wiki Pages > Activity - Write Documentation
|
Activity - Write Documentation
|
|
|
|
|
|
Activity Information Write Documentation
DescriptionThis activity is centered on creating the planned content for the product. Following the documentation outlines and documentation plan, the user education specialist uses specifications, working product builds when available, and discussions with other team members writing the content for the product. Attributes| Element Categories | [CMMI Track 5] Deploy, [CMMI Level 3] TS SP 3.2 | | Entry Criteria | Documentation Plan:
Documentation plan has been approved by the product team.
Project Style Guide:
A style guide and documentation template is available for the project.
Complete functional specifications:
Specifications describe the intended user experience.
Working product builds:
Product builds are available where the features being documented are working. | | Exit Criteria | Product Documentation Review Drafts:
Product documentation review drafts.
Product Documentation Final Drafts:
Product documentation final drafts. | | Is Required | Yes |
StepsStart by Using the Documentation Template:
Review the project style guide.
Familiarize yourself with the documentation template and its intended use.
Determine how the style guide and documentation template must be used to create the content. Create Wireframe from Documentation Outlines:
Create a table of contents from the documentation outline.
Create placeholder topics for all topics in the documentation outline.
Use the documentation template where appropriate. Fill In Content:
Use functional specifications and working product builds to write procedures.
Read specifications and meet with subject matter experts to write conceptual content.
Follow the project style guide and terminology list to ensure consistency.
Index the content. Logically Connect Content to Product Builds:
Work with developers to determine whether there will be context-sensitive help and how it will be logically connected.
Perform tests to check functionality.
Connect the appropriate topics for each available product context.
|
Last modified at 12/19/2007 10:37 AM by Administrator
|
|
|
|
 |
|
|
|
|