Nortel Networks NN47230-103 manual Work flows, task flows, and procedures, Purpose statements

Page 25

Work flows, task flows, and procedures 25

The task flows guide you through activities to use the Nortel Ethernet Routing Switch 8600, whether it is configuration, upgrading, installation, maintenance, or troubleshooting.

Each flow provides the prerequisites and links to the tasks or procedures.

To perform or refer to a procedure, always follow the task flow. Following the task flows ensures that you meet all the requirements for successful completion of the task.

Work flows, task flows, and procedures

Work flows, task flows, and procedures have similar elements to maintain consistency and usability. Each section has a specific function.

“Purpose statements” (page 25)

“Prerequisites” (page 25)

“Work flows or task flows” (page 25)

“Procedure steps” (page 25)

“Example procedures” (page 26)

“Variable definitions” (page 26)

“Job aid” (page 26)

To understand the relationship between work flows, task flows, and procedures, see Figure 1 "Work flows, task flows, and procedures in task-based documentation" (page 24).

Purpose statements

Purpose statements explain why or when you would perform a work flow, task, or procedure and its impact.

Prerequisites

Prerequisites lists everything you must do or understand before you start the workflow, task, or procedure, such as tasks that should already be completed, risks, confirmation of system status, required knowledge, time estimates or limitations, and links to supporting information.

The prerequisite section is omitted if no required prerequisites exist.

Work flows or task flows

This section is the flow chart diagram that represents the task flow with navigational links to the tasks or procedures in the flow.

Procedure steps

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

Nortel Secure Network Access Switch

Documentation Roadmap

NN47230-103 01.01 Standard

28 July 2008

Copyright © 2008 Nortel Networks

Image 25
Contents Documentation Roadmap Legal Notice Contents Customer service Nortel Networks software license agreement Software licenseGeneral Nortel Networks software license agreement Software license New in this release FeaturesOther changes New in this release Navigation IntroductionIntroduction Roadmap Nortel Secure Network Access documentation packagingProduct fundamentals Installation and commissioningAdministration and security Upgrades and patchesOperations Document title Description Fault and performance managementInformation quality Information quality Angle brackets less than, greater than Text conventionsAsterisk Bold Courier textBrackets Separator greater than symbolEllipsis points Italic textTrademarks Trademarks Task-based documentation Modular task-based informationTask flow overview How is task-based documentation used?Purpose statements Work flows, task flows, and proceduresTask-based documentation terms Example proceduresUpdated versions of documentation Getting help Customer serviceExpress Routing Codes For information about Contact Additional informationPage Documentation Roadmap