Task-based documentation terms

28Modular, task-based information

Procedure steps

Procedures provide numerical steps that help you perform the procedure. Each step is a single action.

Example procedures

Some procedures use examples to show how to correctly perform the procedure with realistic settings.

Variable deﬁnitions

Variable definitions provide the possible values, ranges, or definitions of variables used in the procedure steps.

If variables are not used in the procedure, then the variables definition section is omitted.

Job aid

Job aids provide information help to successfully perform the procedure.

The job aid is only used when required.

The following table describes task-based documentation terms.

Term	Description

Work flow	A high or top-level group of tasks.

Task or task flow	A logical group of procedures
	represented as a single action in a
	flowchart diagram. Complex tasks
	can be divided into simpler tasks or
	subtasks.

Procedure	A logical group of single action steps
	in a task.

Step	A single action performed in a
	procedure.

Variable	A placeholder in procedure steps
	representing a value or definition.

Restructuring Nortel technical documents into a task-based format is an ongoing initiative. The documentation for some Nortel products is already converted to the new format.

Nortel Ethernet Routing Switch 2500 Series

Documentation Roadmap

NN47215-103 01.01

27 October 2008