Prepare or Revise User / Technical Documentation, Technical Writer

Description

The User and Technical documentation are prepared or revised based upon the specifications provided in the Functional Specification or related design documentation.

This can include user guides, help systems, technical support documentation, etc.

Where possible, the documentation is produced by interviewing people who are using the solution or will be the end users of the product.  Usability evaluation teams may also be involved with the preparation of the documentation.

All documents are formally reviewed before completion.

Audit Criteria

  • Drafts of documents prepared according to their specifications.
  • The drafts are formally reviewed prior to inclusion in the release.

Document Templates

  • Template Links
  •  

Forms

  • Form Links
  •  

Process Details

  • Other links
  •  

References

Software Engineering

  • CMMI Engineering:  Technical Solution
  •  

Additional Details