Method Documentation

Definition

Method Documentation

the process engineering task during which a method is documented and communicated to its stakeholders

Classification

As illustrated in the preceding figure, Method Documentation is part of the following inheritance hierarchy:

• Type: Concrete
• Superclass: Tasks
• Subclasses: None

Responsibilities

The typical objectives of Method Documentation are to:

• Document the endeavor-specific mrocess.
• Communicate the endeavor-specific mrocess to its stakeholders.

Preconditions

Method Documentation typically can begin when the following preconditions hold:

• The endeavor is started.
• The process team is staffed and trained in process tailoring.
• Significant parts of the initial method description document are relatively complete and stable.

Completion Criteria

Method Documentation is typically complete when the following postconditions hold:

• The method has been documented (e.g., in the form of a document or stored within a process repository).
• The method has been communicated to the relevant stakeholders.
• The endeavor is complete.

Steps

Method Documentation typically involves the process team performing the following steps in an iterative, incremental, and parallel manner:

• Read the content and format standard for the method description document.
• Use the template for the process description document to create a skeleton document.
• Create front matter and introduction section.
• Document Work Product Method Components
  Document each work product to be produced by the method. For each work product:
  • Document Descriptions
    Update the method description document or equivalent (e.g., descriptive website) by creating descriptions (e.g., definition, objectives, benefits, contents, stakeholders, phases, preconditions, inputs, and guidelines).
  • Document Conventions
    Create associated conventions (e.g., content and format standards, templates, and inspection checklists).
• Document Method
  The process team documents the endeavor’s method in the associated method description document.
• Communicate the method to the:
  • Training Team.
  • Project Team.
  • Customer Representative(s).
  • Subcontractor Organization(s).

Techniques

Method Documentation can typically be performed using the following techniques:

• Documentation
• Website

Work Products

Method Documentation typically results in the production of the following work products:

• Method Description Document
• Email notifications
• Descriptive website

Guidelines

• The method will not succeed unless it is properly communicated to all relevant stakeholders.