Definition

Reference information contains facts, specifications, or data that readers might want to access. Examples include:

• API descriptions

• Command syntax

• Specifications

• Requirements

• Performance data

• Database schema definitions

Purpose

Writers include reference information to:

• Provide supporting information for tasks

• Make facts available

Role in product content

Reference topics support tasks in information domains where tasks can be concretely described. Reference topics gain more importance in information domains that do not lend themselves to task-oriented content.

Reference types

Requirements

The Requirements type provides values for required elements, such as required hardware, software, and tools.

Specifications

The Specifications type provides values for hardware-related elements of a system that includes the following:

• dimensions, such as height and weight

• environmental, such as temperature and density

• capacities, such as memory and bandwidth

• system or components, such as power, jumper settings, and pinouts

Command Reference

The Command Reference provides a list of system commands and can include command names, descriptions, variables, and examples. Sections of this information can be used in other topics.

Worksheet

The worksheets type includes information the user must gather and record or lists of tasks that the user must complete in sequence.

General reference

The General Reference type includes lists and tables of reference information that does not fit into one of the other defined reference types. An example of a general reference is a related documents list.

API

The API type provides API information and can include description, syntax, example, and usage.

Reference topic templates

The following templates are available to create reference type topics:

In addition to the standard templates, you can also use the specific reference-type templates: Documentation, Document titles, and Prerequisites.