Manuals / Nortel Networks / Computer Equipment / Switch

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

Models: NN47230-103

1 30

Download 30 pages 28.92 Kb

Page 26

Example procedures

26Modular task-based information

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.

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

Image 26

Nortel Networks NN47230-103 manual Task-based documentation terms, Example procedures, Variable deﬁnitions, Job aid

Contents

NN47230-103 Nortel Secure Network Access SwitchDocumentation Roadmap 324390-ACopyright 2008 Nortel Networks All Rights Reserved Nortel Secure Network Access Switch Release Publication NN47230-103Document status Standard Document release date 28 July Sourced in Canada, the United States of America, and IndiaNew in this release ContentsSoftware license IntroductionNortel Secure Network Access Switch Documentation Roadmap Customer serviceUpdated versions of documentation Task-based documentation termsSoftware license Nortel Networks software license agreement4. General 6 Software licenseNortel Networks software license agreement NN47230-103 01.01 Standard 28 July Nortel Secure Network Access Switch Documentation Roadmap8 Software license Copyright 2008 Nortel NetworksNew in this release Features“Features” page “Other changes” page Other changesNN47230-103 01.01 Standard 28 July Nortel Secure Network Access Switch Documentation Roadmap10 New in this release Copyright 2008 Nortel NetworksNavigation “Customer service” pageIntroduction “Roadmap” page “Information quality” page “Text conventions” pageNN47230-103 01.01 Standard 28 July Nortel Secure Network Access Switch Documentation Roadmap12 Introduction Copyright 2008 Nortel Networks“Product fundamentals” page “Installation and commissioning” page Nortel Secure Network Access documentation packaging“Nortel Secure Network Access documentation packaging” page “Upgrades and patches” page “Administration and security” pageDocument title Installation and commissioningProduct fundamentals DescriptionOperations Upgrades and patchesAdministration and security OperationsDescription Fault and performance managementDocument title Document titleInformation quality NN47230-103 01.01 Standard 28 July Nortel Secure Network Access Switch Documentation Roadmap18 Information quality Copyright 2008 Nortel Networksasterisk Text conventionsangle brackets less than, greater than bold Courier textellipsis points separator greater than symbolbrackets italic textTrademarks NN47230-103 01.01 Standard 28 July Nortel Secure Network Access Switch Documentation Roadmap22 Trademarks Copyright 2008 Nortel NetworksTask-based documentation “Work flows, task flows, and procedures” pageModular task-based information “Task-based documentation” pageWork flows, task flows, and procedures in task-based documentation How is task-based documentation used?Task ﬂow overview “Work flows or task flows” page “Procedure steps” page Work ﬂows, task ﬂows, and proceduresProcedure steps “Example procedures” page “Variable definitions” page “Job aid” pageVariable deﬁnitions Example proceduresTask-based documentation terms Job aid“Updated versions of documentation” page “Getting help” page Customer serviceUpdated versions of documentation Getting helpFor information about Additional informationNortel Secure Network Access Switch Documentation Roadmap ContactPage Nortel Secure Network Access Switch Documentation Roadmap