Nortel Networks NN47230-103 manual Task-based documentation terms, Example procedures

26Modular task-based information

Example procedures

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

Variable definitions

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.

Task-based documentation terms

Task-based documentation uses the following terms.

Term	Description
Work flow	A high-level or top-level group of
	tasks.
Task or task flow	A logical group of procedures that is
	represented as a single action in a
	flowchart diagram. Complex tasks
	can be divided into simpler tasks or
	subtasks.
Procedure	A logical group of steps that can be
	described as a single action in a task.
Step	A single action that is performed in a
	procedure.
Variable	A placeholder in procedure steps that
	can represent 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 Secure Network Access Switch

Documentation Roadmap

NN47230-103 01.01 Standard

28 July 2008

Copyright © 2008 Nortel Networks