GR 454 CORE : ISSUE 1

1. Introduction
   1.1 Purpose
   1.2 Scope
   1.3 Relationship to Other Bellcore Documents
   1.4 Organization of the Document
   1.5 Requirements Terminology
   1.6 Requirement Labelling Conventions
2. Beginning Consideration
   2.1 Human Factors Considerations in Documentation
   2.2 Comprehensiveness
   2.3 Comprehensibility
   2.4 Consistency in Format, Terminology, and Numbering
   2.5 General Requirements
3. Determine Functional Category, Subject Area, and Subset
   3.1 Overview of Functional Categories
   3.2 Switching
   3.3 Transport
   3.4 Operations
   3.5 Common/Miscellaneous
   3.6 General Requirements
4. Requirements for Developing Documents, by Subject Area
   4.1 General Documentation Subject Area
   4.2 Power Documentation Subject Area
   4.3 System Capacity Subject Area
   4.4 Network Element Interface Subject Area
   4.5 Office Records Subject Area
   4.6 Software and Translations Subject Area
   4.7 Planning and Engineering Subject Area
   4.8 Inventory and Ordering
   4.9 Installation Subject Area
   4.10 Provisioning Subject Area
   4.11 Maintenance Subject Area
   4.12 Database Administration Subject Area
   4.13 Billing Subject Area
   4.14 Reliability and Quality Subject Areas
5. Prepare Draft Documentation
   5.1 Overview
   5.2 Develop a Plan
   5.3 Determine Delivery Requirements
   5.4 Prepare Documentation Guide
   5.5 Standalone Documents
   5.6 Principles of Effective Writing
6. Verify The Information
   6.1 Verify What Tasks Are Required
   6.2 Verify How Tasks Are Performed
   6.3 Review Technical Details for Accuracy
   6.4 Review Audience and Format Requirements
7. Format and Package the Information
   7.1 Format and Structure Characteristics for
       Electronic and Paper
   7.2 Electronic Documentation
   7.3 Paper Documentation
8. Distribute The Documentation
9. Follow-Up Evaluation
   9.1 Overview
   9.2 Check for the Appropriate Level of Detail
10. Update The Documentation
    10.1 When to Use an Addendum
    10.2 When to Use a Revision
    10.3 When to Reissue a Document
Appendix A: Documentation Preparation Process for
            Procedural Documentation
            A.1 An Overview
            A.2 Perform Task Analysis
            A.3 Simplified Procedure
Appendix B: A Task-Oriented Practice Approach to
            Preparing Procedural Information
            B.1 What is a Task-Orientated
                 Practice (TOP)?
Appendix C: An Information Mapping Approach to
            Preparing Procedural Information
Appendix D: How to Best Present Information
            D.1 Presenting Various Kinds of
                Information Within Documents
Appendix E: Network Element Documentation Checklist
Appendix F: Severity Definitions
            F.1 Introduction
            F.2 Severity Definitions for Switching
                and Transport Systems
            F.3 Severity Definitions for Operations
                Systems
Appendix G: Binding and Packaging Option for Paper
            Documentation
            G.1 Binding the Documentation
            G.2 Packaging the Documentation: An Overview
            G.3 User-Oriented Documentation Packaging
References
Glossary
List of Figures
3-1. Relationship between Categories, Subject Areas, and
     Subsets
5-1. Flow Diagram Showing How to Prepare Draft Documentation
A-1. How to Prepare Documentation: Flow Diagram
A-2. An Example of Task Analysis : Documentation Preparation
     Procedures and Development Requirements
B-1. Example of a TOP Listing
B-2. Example of a TOP Flowchart
B-3. Example of a TOP Functional Block Diagram
B-4. Example of a TOP Schematic Diagram
B-5. Example of a TOP Text
B-6. Example of a TOP Detailed Level Procedure
C-1. Example of Information Mapping (Procedure Map) Format
G-1. Documentation Packaging Details
List of Tables
3-1. Subject Areas and Associated Subsets
4-1. Subject Area and Subset Documentation Development
     Requirements Index
4-2. Example of Feature Index
4-3. CLEI Code Format
5-1. Subsets That Must Be Standalone Documents
10-1. An Example of a Document's Change of History Section
10-2. A Guide to Selecting an Update Format
D-1. A Guide to Presenting Information
E-1. Format Matrix for General Information
E-2. Format Matrix for Power Documentation
E-3. Format Matrix for System Capacity Documentation
E-4. Format Matrix for Network Element Interface
     Documentation
E-5. Format Matrix for Office Records
E-6. Format Matrix for Software Documentation
E-7. Format Matrix for Planning and Engineering
     Documentation
E-8. Format Matrix for Inventory and Ordering
     Documentation
E-9. Format Matrix for Installation Documentation
E-10. Format Matrix for Provisioning Documentation
E-11. Format Matrix for Maintenance Documentation
E-12. Format Matrix for Billing Documentation
E-13. Format Matrix for Database Administration
      Documentation
E-14. Format Matrix for Reliability and Quality
      Documentation
E-15. Subsets That Must Be Standalone Documents
G-1. Matrix for Choosing a Binding for Documentation

Suppliers generally prepare documentation from a supplier's point of view rather than a user's viewpoint, which tends to be very different. Any two suppliers rarely view a product or its documentation in the same way. Even various departments within the same company may differ in the way they prepare documentation. All of these differences have caused confusion for Network Element (NE) users. This standard outlines generic requirements for NE documentation that will aid consistency in the content, format, and style of the documentation provided by different suppliers for similar NEs. It also outlines proposed procedures for similar NEs.