Nortel 4134 参考指南

下载
页码 32
28
Modular, task-based information
Procedure steps
Steps in numerical order for performing the procedure. Each step is a
single action.
Example procedures
Some procedures use example procedures to provide the user with a
sample of how the procedure is performed correctly with realistic settings.
Variable definitions
Possible values, ranges, or definitions of any variable used in the procedure
steps.
If variables are not used in the procedure or partial configuration, then the
variables definition section is omitted.
Job aid
Information that assists the user in performing the procedure. The job aid
is usually information that the user must know to complete the procedure
successfully.
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 grouping of tasks.
task or task flow
A logical grouping of procedures that is
represented as a single action in a flowchart
diagram. Complex tasks may be divided into
simpler tasks or sub-tasks.
procedure
A logical grouping 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 Router 4134
Documentation Roadmap
NN47263-103
01.01
Standard
10.0
16 July 2007
Copyright © 2007, Nortel Networks
.