MSF for CMMI Process Improvement Visual Studio Team System logo
workstreams icon

Develop Documentation (CMMI Level 3 : TS 3.2 )

User Education Specialist

Participating Roles

Responsible:

User Education Specialist

Consult:

Tester

Developer

Project Manager

Overview

Entry Criteria

    Dependencies:

    • Personas: Personas are complete.
    • Scenarios: Functional specifications have complete scenarios based on personas.
    • Iteration plan: Iteration plan is complete.
    • Functional specifications: Specifications contain complete descriptions of the user experience.
    • Working product builds: Product builds exist that can be used to create content.

    Activities

    1

    Create Documentation Outlines

    • Create an outline of topics.  
    • Send the outline out for review by the team.

    2

    Create Documentation Plan

    • Estimate resources and schedule.
    • Determine documentation deliverables.  
    • Write documentation plan.  
    • Get sign-off from team.

    3

    Write Documentation

    • Start by using the documentation template.  
    • Create wireframe from documentation outlines.  
    • Fill in content.  
    • Make logical connections from content to product builds, such as enabling F1 support.

    4

    Edit Documentation

    • Review content against the project style guide.  
    • Edit for sense, organization, and completeness.  
    • Edit for consistency and mechanics.

    5

    Perform Peer Review of Documentation

    • Assemble and distribute review.  
    • Collect and incorporate review comments.  

    6

    Test Documentation

    • Test procedures.  
    • Test F1 and help linking.  
    • Schedule and conduct help test pass.  
    • Correct problems found during testing.

    Exit Criteria

    Product product documentation for one or more of the following work products: Planning Guide, Deployment Guide, Installation Guide, Training Guide/Tutorials, Online Help, Maintenance Guide, Operations and Administration Guide, User Guide, Troubleshooting Guide, Disaster Recovery Guide (Information Security Guide), Software Development Kit, Partner/Extensibility Kit, or Marketing Materials.

    (C) 2005 Microsoft Corporation. All rights reserved.

    MSF for CMMI Process Improvement: Build 050707