Generic Requirements for Supplier-Provided Documentation
Document Number GR-454
Issue Number 01
Issue Date Dec 1997
Replaces TR-TSY-000454 Issue01
ABSTRACT: Historically, suppliers have prepared documentation from a supplier's point of view rather than a user's point of view, which tends to
be very different. Rarely do any two suppliers view a product or its documentation in the same way. Even within a telephone operating
company, the various departments often differ in how they prepare documentation. All of these differences have caused confusion for
Network Element (NE) users.
This document presents proposed generic requirements for NE documentation that will help promote consistency in the content, format,
and style of the documentation provided by different suppliers for similar NEs. This document also provides proposed procedures to
assist in the preparation and development of NE documentation. These proposed generic requirements
and procedures were created to help those who follow them produce complete and usable documentation that would benefit users of NEs
when using such material.
The following documents were fully or partly replaced by GR-454: TR-TSY-000454, TR-TSY-000454-SUP01, TR-TSY-000519, TR-EOP-000208,
TA-OPT-000454 and PUB-53300.
When using GR-454, you may need to refer to TCIF-IPI-97 series guidelines. You may also want to refer to GR-63, GR-485,
GR-929, GR-1089, and/or GR-2914.
This GR also includes one or more Issue List Reports (ILRs) that details open or closed technical issues in the main document. The
ILR(s) are automatically sent free of charge to the GR document purchaser.
Components of this product are:
Table of Contents:
View Table of Contents