Prepare Product Support Documentation¶
(Activity) for Tier: Sprint
PURPOSE¶
Product support documentation provides the end user with step-by-step instructions for how to use the associated software product. This documentation, usually in the form of user manuals, administrator manuals, online help, and/or quick start guides, is an industry standard that provides a source for end-user training and typically meets a contract requirement. The purpose of this activity is to prepare the required product support documentation.
When software functionality is stable, the User Education Specialist (UES) begins preparing product support documentation. This activity can include finalizing the product support documentation for delivery with the software. The document should be reviewed by a subject matter expert (SME) for accuracy and the UES for quality. he software. The finalized written content should be reviewed by a SME to ensure accuracy. It must also receive a final review by the UES to ensure product quality.
WHEN¶
Once the design of the applicable functionality is stable enough to document.
PARTICIPATING ROLES¶
- ACCOUNTABLE
INPUTS¶
- Work Item
- Working Software Build
- Supplementary material such as mockups/prototypes (Optional)
ENTRY CRITERIA¶
- Design of application functionality is stable.
- Work Items such as a User Stories and Tasks are assigned to UES.
SUB-ACTIVITIES¶
Write Content
- Review all applicable work items (features, user stories, and tasks) - along with any related supplementary material (e.g., mockups, prototypes, workflow diagrams, latest software build).
- Based on the specified business needs and relevant designs, write and organize the product support documentation.
Edit Content
- Based on any changes to the initial design as they appear in the design artifacts or in a working software build, edit the product support documentation to ensure accuracy.
Finalize the Product Support Documentation
- Once the implementation of the software is stable and the scope of the product build has been determined, ensure the drafted product support documentation covers all functionality included in the software.
- Prepare the finalized draft for review by a PO and/or SME, as needed.
Review the Product Support Documentation
- For each applicable feature and/or user story the SME/PO or another designated team member (as specified in the project documentation plan) performs a review of the written content to ensure accuracy. The technical writer identifies features that have been added or deleted and locations of changes within the document.
- Prepare criteria to be used for reviewing documentation. This should specify the expectations for reviewers.
- Once the review of the draft is complete, the SME/PO provides written feedback to the UES regarding the accuracy of the content or any recommended changes. Feedback should be documented in a predetermined location such as the Discussion area of the review task.
Make necessary edits
- Review any recommendations from the SME/PO and make edits as needed.
- Perform a final review of the product support documentation to ensure quality and document results.
Complete the Product Support Documentation
- Provide the product support documentation to the specified location for inclusion in the product build.
- If the document is a contract deliverable, deliver it according to the Deliver Contract Deliverable Documentation activity.
EXIT CRITERIA¶
An updated version of the product support documentation.