TR TSY 000454 : ISSUE 1

1. INTRODUCTION
1.1 Change History
1.2 Supplier Documentation
1.3 Network Elements
1.4 Requirements and Objectives
1.5 Target Audiences
1.5.1 Suppliers
1.5.2 Bell Operating Companies (BOCs)
2. DOCUMENTATION FOR ALL WORK GROUPS
2.1 Documentation Scope
2.2 Documentation Availability and Timing
2.3 Documentation Format
2.4 Documentation Updates and Product Change Notices
2.5 Documentation Guide
2.6 Product Description
2.6.1 General Description
2.6.2 Feature Descriptions
2.6.3 Safety Requirements
2.7 Hardware and Software Descriptive Documentation
2.7.1 Hardware Descriptive Documentation
2.7.2 Software Descriptive Documentation
2.8 Network Element Interface Documentation
2.8.1 Hardware Requirements at a Network Element
           Interface
2.8.2 Software Requirements at a Network Element
           Interface
2.8.3 Operations Systems Network Element Interfaces
2.8.4 Inter-Supplier Network Element Interfaces
2.9 Training
3. DOCUMENTATION FOR PLANNERS AND ENGINEERS
3.1 Product Specifications
3.1.1 Product Technical Specification
3.1.2 Product Reliability and Quality Specification
3.2 Planning Documentation
3.2.1 Product Planning Guide
3.2.2 Hardware Documentation
3.2.3 Software Documentation
3.2.4 Price and Cost Information
3.2.5 Scheduling Information
3.3 Engineering Documentation
3.3.1 Building Engineering
3.3.2 Equipment Engineering
3.3.3 Traffic Engineering
4. DOCUMENTATION FOR INVENTORY AND ORDERING
4.1 Common Language Documentation
4.2 Ordering Guide
5. DOCUMENTATION FOR INSTALLATION GROUPS
5.1 Installation Documentation
5.1.1 Installation Procedures
5.1.2 Growth Installation Procedures
6. DOCUMENTATION FOR PROVISIONING GROUPS
6.1 Provisioning Documentation
6.1.1 Provisioning Guide (Manual Applications)
6.1.2 Database Provisioning Guide
6.2 Record-Keeping Documentation
6.2.1 Hardware Records
6.2.2 Software Records
6.3 Assignment Documentation
7. DOCUMENTATION FOR MAINTENANCE GROUPS
7.1 System Maintenance Documentation
7.1.1 Maintenance Procedures
7.1.2 Alarm and Performance Monitoring Information
7.1.3 System Recovery Procedures
7.1.4 On-Site Field Repair Instructions
7.1.5 Hardware Documentation for Maintenance
7.1.6 Software Documentation for Maintenance
7.2 System Test Information
7.2.1 Circuit, Facility, and Equipment Test Procedures
7.2.2 Software Test Procedures
8. DOCUMENTATION FOR DATABASE ADMINISTRATION
8.1 Database Administration Documentation
8.2 Traffic Administration Documentation
8.3 Network Traffic Management Documentation
8.4 Network Element System Administration
           Documentation
9. DOCUMENTATION FOR BILLING GROUPS
10. RELIABILITY AND QUALITY ASSURANCE
10.1 Supplier Quality Control of Documentation
10.2 Product Reliability and Quality Requirements
10.2.1 System Design Documentation
10.2.2 Development & Manufacturing Program Documentation
10.2.3 Software Quality Program Documentation
10.2.4 Product Support and Field Reliability Documentation
11. APPENDIX A - TOP-FORMAT DOCUMENTATION
11.1 General Considerations
11.2 TOP-Format and New Products
12. APPENDIX B - TOPICS FOR SUPPLIER DOCUMENTATION
13. GLOSSARY
13.1 Terms
13.2 Acronyms, Abbreviations, and Trademarks
14. REFERENCES
15. DOCUMENT ORDERING INFORMATION

Bellcore's view of generic requirements and objectives for documentation that suppliers are expected to provide with Network Elements purchased by a BOC. They apply to complete transport and switching systems and to their sub-systems and components. One section is of common interest to all BOC work groups; others cover Planning and Engineering, Inventory and Ordering, Installation, Provisioning, Maintenance, Database Administration, Billing and Reliability/Quality Assurance. Appendix A addresses TOP-format documentation. This TR will be referenced in the LSSGR, the OTGR and the TSGR. TR-EOP-000208 on software documentation for SPC Switching Systems will eventually be superseded and re-issued as a supplement to this TR.