Activity Information Edit Documentation
DescriptionEditing 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. Attributes| Element Categories | [CMMI Track 5] Deploy, [CMMI Level 3] TS SP 3.2 | | Entry Criteria | Product Documentation Review Drafts
Product Documentation Final Drafts | | Exit Criteria | Product documentation is clear, concise, and organized:
Product documentation is clear, concise, and organized.
Product documentation follows project style and terminology guidelines:
Product documentation follows project style and terminology guidelines. | | Is Required | Yes |
StepsReview 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. 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. Edit for Consistency and Mechanics:
Correct grammar, spelling, and punctuation errors.
Correct inconsistencies in tone, depth, and writing approach.
Correct legal or localization issues.
|
Last modified at 12/19/2007 10:37 AM by Administrator
|
|