Guideline: Detailing Method Content Using Templates
Relationships
Main Description

Method content descriptions can be written using templates.  The resulting documents can then be used to collaboratively complete the content.

This method of method element authoring is appropriate when:

  • A method authoring tool is not being used.
  • There is a need for support for markup and reviews of the content being developed that is not provided in the method authoring tool being used.
  • There is a reason not to have each author use the authoring tool directly for authoring the content (for example, the desire to not have to train all the SMEs to use the tool before they can provide content).

To use templates:

  • Create a template that represents the information you want to capture for each type of method element.
  • Make the templates available to the content authors (e.g., via a customized Method Authoring Method).
  • Complete and review the content for each content element to be authored in this fashion.
  • Once the content has been reviewed and approvide, migrate the content into the the method authoring tool.

Once the content in the template has been reviewed and is fairly stable, if a method authoring tool is being used, the content can be migrated to the tool.