Example Procedures; Variable Definitions; Job Aid; Task-Based Documentation Terms - Nortel 8600 Documentation Roadmap

40 Modular, 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
Work flow
Task or task flow
Procedure
Step
Variable
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.
Copyright © 2008 Nortel Networks
.
Nortel Ethernet Routing Switch 8600
Documentation Roadmap
NN46205-103 01.01 Standard
19 May 2008
Description
A high-level or top-level group of
tasks.
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.
A logical group of steps that can be
described as a single action in a task.
A single action that is performed in a
procedure.
A placeholder in procedure steps that
can represent a value or definition.