|
|
 |
 |
 |
 |
Activity:
Edit Documentation (CMMI Level 3 : TS 3.2 )
 |
|
Participating Roles
Responsible:
User Education Specialist |
Editing documentation ensures that the content for the product documentation is consistent in terminology, depth of coverage, and style; that it conforms to the selected documentation template, and that the content is understandable, complete, and contains no grammatical, spelling, or punctuation errors.
Entry Criteria
Dependencies:
- Product Documentation Review Drafts:
- Product Documentation Final Drafts:
Sub-Activities
|
|
1 |
Review Against the Project Style Guide |
- Ensure that the content follows the project style guide.
- Add items to the project style guide as style decisions are made.
|
|
2 |
Edit for Sense, Organization, and Completeness |
- Review overall organization and indexing.
- Correct ambiguous, awkward, or unclear areas.
- Ask the writer if you are unsure whether modifications change the meaning.
|
|
3 |
Edit for Consistency and Mechanics |
- Correct grammar, spelling, and punctuation errors.
- Correct inconsistencies in tone, depth, and writing approach.
- Correct legal or localization issues.
|
Exit Criteria
 |
Product documentation is clear, concise, and organized. |
|
Product documentation follows project style and terminology guidelines. | |
 |
 |
 |
 |
(C) 2005 Microsoft Corporation. All rights reserved.
MSF for CMMI Process Improvement: Build 050707 |
|
Program Management
