Guideline: Reviewing Methods
This guideline provides recommendations for reviewing methods.
Relationships
Main Description

When reviewing a method, it is important to examine the method realization in authored and published form, as well as any supporting documentation.

The following are some general things to consider when reviewing authored content:

Ensure that there is an acceptable level of quality in content prior to releasing that content for initial customer evaluation. This is a list of proposed reviews that should be performed on the content before it can be considered ready for initial release.

  • Review for readability and consistent voice
    • Make sure the authoring guidelines have been adhered to.
    • Check the visual layout/flow of text
       
  • Review for content correctness and consistency
    • Review the content focusing on a vertical slice, such as per process, per scenario, and so on.
    • Make sure the content has appropriate links to other content
        
  • Copy-edit review
      
  • Review for usability
    • Check the layout of the navigation views
    • Make sure that a critical portion of guidance is "above the fold", meaning it can be seen on main portion of the screen without need for scrolling the page down.
    • User scenarios: Have the reviewers put themselves in one or more roles below and try to accomplish the actions described.  For example:
      • See if the project manager can use the content to plan the project
      • See if the developer can find specific content
      • See if process engineer can customize the content by adding company-specific content
      • See if a first time user can easily navigate and follow the process (is there enough introductory content)