Skip to main content

MSF for CMMI Process Improvement

Go Search
Home
  
MSF for CMMI Process Improvement > Wiki Pages > Activity - Test Documentation  

Activity - Test Documentation

Activity Information

Test Documentation

Description

Testing the documentation ensures that the procedures match the working product builds and that all context-sensitive help and linking in online help are working.

Roles

ResponsibleUser Education Specialist
ConsultedTester

Attributes

Element Categories[CMMI Track 5] Deploy, [CMMI Level 3] TS SP 3.2
Entry Criteria

Product builds:
Context-sensitive help is working in product builds.

Procedures:
Documentation procedures have been written.

Exit Criteria

Context-sensitive help has been tested for all working features in the product.:
Context-sensitive help has been tested for all working features in the product.

Help links have been tested.:
Help links have been tested.

Any problems found have been corrected or bugs have been filed.:
Any problems found have been corrected or bugs have been filed.

Is RequiredYes

Steps

  1. Test Procedures:

    Step through each procedure using the latest product build.

    Review conceptual material to ensure it applies to the product as planned for release.
  2. Test Help Linking:

    Test context-sensitive help links.

    Test help links to topics within and external to the help file.

    Ensure the link text matches the topic title.
  3. Schedule and Conduct Help Test Pass:

    Work with the tester to schedule help testing.

    Consider setting aside a day for the entire team to help find bugs in the help file.
  4. Correct Problems Found During Testing:

    Use bug work items to track help problems.

    Check product builds after changes have been made to ensure the problems are fixed.

Predecessors

TypeNameDependency Type
Perform Peer Review of DocumentationFinish-Start

Last modified at 12/19/2007 10:37 AM  by Administrator