AT&T 76450 User Manual

Page 25

Common Systems Connection Standards AT&T Services, Inc
Date: June 2013

ATT-TP-76450, Issue 15

Page 25

7.5

Alarm/Trouble Shooting Guide

Vendor must test and validate that a new user can use the Alarm or Trouble Shooting guide to
successfully identify and clear alarms

7.6

Personnel Injury and Equipment Damage Warnings

Documentation must keep the user aware of personnel injury and equipment damage by using
the appropriate warnings, dangers, or cautions preceding procedures and incorporating the
appropriate steps within the procedures.

7.7

Reference Guide

Documentation must include a “Reference” guide that describes each component of the NE in
detail

Example: Photographs or detailed drawings of the faceplates of each plug-in with a description
of the LEDs in a normal state and in an alarm or other informational state, optical connection
type, if applicable, power requirements , etc

7.8

Consistent Terminology throughout Documentation

Per GR-454-CORE, Section 2.4, terminology must remain consistent throughout all
documentation for a platform.
Example: Maintenance Mode must remain Maintenance Mode and not vary to Maintenance
Condition or Maintenance State

7.9

Consistent Terminology between Documentation and Platform.

Per GR-454-CORE, Section 2.4, terminology must be consistent between the documentation
and the platform.

Example: If it is referred to as Maintenance Mode in the documentation it must be
Maintenance Mode in the Craft and EMS GUIs.

7.10

Revision Numbering

Documentation shall be clearly marked on each page with Revision numbers to indicate when
changes are made within the document.

7.11

Revision History

A revision history section shall be included to clearly indicate what and where changes are
made within the document.