Documentation Studies

Definition

Documentation studies is a common technique consisting of reading and studying available documentation for content that is relevant to and useful on the current endeavor.

Discussion

TBD

Objectives

The typical objectives of documentation studies are to:

• Identify reusable intellectual property (e.g., requirements, architectures, designs).
• Better understand an application domain, application, business, or commercial products.

Preconditions

Documentation studies can typically begin when the following preconditions hold:

• A need for information has been identified.
• Relevant documentation exists:
  • Customer organization documentation
  • Development organization documentation
  • Marketing organization documentation
  • User organization documentation
  • Vendor organization documentation

Completion Criteria

Documentation studies is typically complete if the following postconditions hold:

• All relevant documentation has been studied.
• All relevant information in the documentation has been identified and documented.

Steps

During documentation studies, various rolls typically perform the following steps:

• Identify relevant documentation.
• Obtain relevant documentation.
• Actively read relevant documentation.
• Identify relevant information.
• Informally document the relevant information.

Work Products

Documentation studies typically results in the following work products:

• Informally documented information from the documentation that was studied.

Limitations

Documentation studies is typically subject to the following limitations:

• Relevant documentation must exist and be available.

Guidelines

• Read actively (i.e., in search mode for relevant information).