1、CEPT T/CS*OL-LO*E 4 W 2326414 0004445 2 W. - Page E 1 Recommendation T/CS 01-10 (Montpellier 1984) DOCUMENTATION REQUIREMENTS FOR DIGITAL SWITCHING SYSTEMS Recommendation proposed by Working Group T/WG 11 “Switching and Signalling” (CS) Text of the Recommendation adopted by the “Telecommunications”
2、Commission: “The European Conference of Postal and Telecommunications Administrations, considering - that there is a world wide trend in introducing digital exchanges into the public switched telephone networks; - that Administrations may introduce several types of digital systems into their telepho
3、ne network; - that these digital exchanges can only be operated and maintained when there is an adequate documentation; - that the content and structure of the documentation employed by different manufacturers vary considerably; - that this diversity presents difficulties in the operation of several
4、 types of systems in one national network, recommends that members of the CEPT, when specifying their national documentation requirements, adopt the approach outlined in this Recommendation.” Q Edition of May 15, 1986 o CEPT T/CS*BL-LO*E 84 2326434 O004446 4 m: TICS O1 -10 E Page 3 Contents Part I .
5、 Foreword . 5 1 . GENERAL . 5 2 . SCOPE OF THE RECOMMENDATION 5 3 . LAYOUT OF THE RECOMMENDATION . 5 Part II . Docitinentation requireinents for digital switching systems 6 1 . GENERAL . 6 1.1. Structure of the documentation . 6 1.2. General requirements for software documentation . 6 1.3. General r
6、equirements for hardware documentation . 6 2 . DOCUMENTATION SCHEME DESCRIPTION 8 3 . SITE.INDEPENDENTDOCUMENTS 8 3.1. Descriptions . 8 3.1.1. System overall description (level I) 8 3.1.1.1. General requirements . 8 3.1.1.2. Special requirements For software documentation . 9 3.1.2. Description of s
7、ub-systemslfitnctional blocks and special topics (level 2) 9 3.1.2.1. Description of sub-systems/Functional blocks . 9 3.1.2.1.1. General requirements 9 3.1.2.1.2. Special requirements for hardware descriptions . 9 3.1.2.1.3. Special requirements For software documentation 9 3.1.2.1.4. Special requi
8、rements for fismware documentation 9 3.1.2.2. Special topics 9 3.1.3. Description of hardware (level 3) . 10 3.1.4. Description of software (level 3) . 10 3.2. Detailed hardware documents (level 4) 10 3.2.1. Documents for components . 10 3.2.2. Documents for assemblieslsub-assemblies . 10 3.2.3. Doc
9、uments for standardized equipping and cabling 11 3.3. Detailed software documents (level 4) 11 3.3.1. Module catalogue 11 3.3.2. Source listings 11 3.3.3. Linklisting . 12 3.3.4. Data definitions . 12 3.4. Manuals . 12 3.4.1. Operating manual(s) 12 3.4.2. Maintenance manual(s) . 13 3.4.3 Engineering
10、 and ordering manual . 13 3.4.4. Installation methods manual . 13 3.4.5. Acceptance test procedures manual . 13 3.4.6. Command and print-out manual 13 3.4.6.1. Commandlist 13 3.4.6.2. List of print-outs . 13 3.4.1. Maniral for repair and testing of equipment 13 4 . SITEXPECIFIC DOCUMENTS 14 4.1. Det
11、ailed hardware documents 14 4.2. Detailed software documents 14 4.3. Exchangedata 14 Edition of May 15. 1986 / 7 i - CEPT T/CS*OL-LO*E 4 232b414 0004447 b T/CS O1 -1 O E Page 5 Part I. Foreword 1. GENERAL It is clear that modern switching systems, especially digital, can only be pla ned, installed,
12、tested and operated if appropriate documentation is available. The types of documentation range from a general representation of the system, which may represent a part of documentation needed during the tendering stage, through to a detailed description and other documents usually required when a co
13、ntract is concluded. The structure of documentation employed by different manufacturers varies considerably and this diversity presents difficulties when comparing systems and in the operation of several types of systems in one national network. It is recognised that some administrations may already
14、 have dened their documentation requirements and agreed these with their switching system suppliers. Changes to these requirements and agreements may not be practical in the short term, but it is recommended that administrations adopt the general approach outlined in this Recommendation in the longe
15、r term. It is not expected that manufacturers should be required to change their existing documentation to meet this Recommendation, but they should at least demonstrate that they have covered ail the points highlighted in the following structure. It should be pointed out that the subject cdocumenta
16、tion” is also dealt with in chapter VI1 of CCIT Handbook GAS 6 (Choice of telephone switching systems). If parts thereof have been used in this Recommendation it is expressly noted. 2. SCOPE OF THE RECOMMENDATION This Recommendation covers the general documentation requirements for digital switching
17、 systems but to a large extent it can also be applied to SPC switching systems in general, The objective of this Recommendation is to provide a generally applicable basis for the requirements imposed on documentation, special emphasis being placed on obtaining a common understanding of the terms use
18、d by defining them clearly. The Recommendation should serve both manufacturers of digital switching systems, and their customers, as a guideline or check list which will help in the preparation of a complete set of documents capable of meeting the various needs of the users. This Recommendation is o
19、nly concerned with the documentation supplied by manufacturers. At a later stage, harmonisation of the documentation that administrations provide to manufacturers for tendering purposes may be considered. Although complete harmonisation of documentation was considered, some points are the subject of
20、 national standards, specications or a matter of negotiation between manufacturer(s) and customer and will be specified in the contract, for example: - the language used; - the media on which the documentation is presented and the way in which it is presented; - the way in which the documentation is
21、 separated into the parts required by individual departments within an administration (planning, operations, maintenance, etc.); - the type, amount and level of detail or the documentation required by an administration at any stage, from tendering through to the introduction of a switching system in
22、to operation, and beyond into the operational phase; - provisions for updating documentation; - the relationship of the switching documentation with 0 the general requirements for other documentation within an administration 0 the documentation facilities already in use within an administration. and
23、 3. LAYOUT OF THE RECOMMENDATION In part II of the Recommendation a general structure is presented giving an overall view of switching system documentation. This structure is also used as the basis for the layout of this Recommendation. Edition of May 15, 1986 i CEQT T/CS*OL-LO*E 84 I 2326434 000444
24、8 8 I TICS O1 -1 O E Page 6 Part II. Docrimeiitntion requirements for digital switching systems 1. GENERAL 1.1, Structure of the documentation The documents required should be classified in an hierarchical structure. In Figure 1 (T/CS 01-10) a general hierarchical structure has been presented to pro
25、vide an overall view of switching system documentation recommended. This particular structure has been agreed as reasonable in view of the complexity of the documentation involved: it is acknowledged that variants of this structure may exist. The structure presented in Figure 1 considers two main as
26、pects: - the purpose an individual document serves - the level of detail a document contains. For the site independent, see in description and detailed documents (see $3.1 to 3.3 below), four different levels of detail are adopted. They are identified by the digits 1 (most general information) throu
27、gh to 4 (most detailed information). The structure only considers system-related documents, to be provided by manufacturers of digital ex- changes for use by administrations. Other types of documentation, e.g. - manufacturer/supplier specific documentation ;I) - system-independent documentation :) -
28、 system support documentation3 are not taken into account. Notes: ) Documents of this type cover the wide range of tasks which a manufacturer has to perform in the field of development, testing, production and administration of the systems software modules and hardware units. Typical examples to thi
29、s type of documentation are manuals, descriptions, etc. of peripheral equipment (e.g. teletypes, visual display units, magnetic tape units, printer terminals, disc units). Usually this equipment is not developed or produced especially for the exchange system. Since this equipment is necessary for sy
30、stem operation and/or maintenance there must be an adequate documentation. 3, In addition to the hardware and the software used in the SPC switching equipment, additional sofware or hardware and the corresponding documentation may be required for development/maintenance of the exchange software, rep
31、air of slide-in units, training purposes, etc. and and 1.2. General requirements for software documentation Software documentation is considered to be a very significant, if not the most important, part of the whole documentation. Therefore, it has to be stressed that the different sections of softw
32、are descriptions must meet the following general requirements: The documentation of the whole software system is assumed to be organized according to the top-down principle and structured in a task oriented way. This means that the software documentation starts with a software system overview (level
33、 i), goes on with a description of the functions of the sub-systems (level 2) and terminates with the documents on module and/or sub-module level (levels 3 and 4). The different documents should be consistent in all respects, and with increasing level number finally lead to the comprehension of the
34、instruction code of the program listing. By searching through the documents at each of the different levels it must be possible to trace each software function and its realization down to module/sub-module level, especially from level 2 to level 4, and vice versa. 1.3. General requirements for hardw
35、are documentation The documentation of the hardware is assumed to be organized according to the top-down principle. This means that the hardware documentation starts with a system overview (level i), goes on with a description of the sub-systems (level 2) and terminates with the documents for functi
36、onal and/or constructional units (levels 3 and 4). Where needed the documents should contain references to other hardware or software documents. CEPT T/CS*OL-LO*E 84 W 2326434 O004449 T W TICS O1 -1 O E Page 7 1 -.-.-.-.-.-.-. I- I II- .-.-.-. Edition of May 15, 1986 U I- -.-.-.- 1 17 CEPT T/CS*OL-L
37、O*E 4 I 2326434 0004450 b TICS O1 -1 O E Page 8 2. THE DOCUMENTATION SCHEME DESCRIPTION There are two requirements that must be met by the documentation scheme description, viz: - to introduce potential users to the documentation scheme, its hierarchical structure (see Figure 1 - to permit quick and
38、 accurate reference to the contents of the documents. To meet these requirements, the system documentation scheme description should include: - a key to the systems documentation; - an extensive subject index, in alphabetical order together with the normal table of contents; - a glossary of system d
39、ependent technical terms and abbreviations; - a method of updating the various constituent parts and indicating the compatibility of different docu- (T/CS 01-10) and the conventions adopted; ments in terms of their revision number. 3. SITE-INDEPENDENT DOCUMENTS The site-independent documents describ
40、e a switching system without considering the variety of circum- stances which might be found with different locations and implementations of exchanges. 3.1. Descriptions 3.1.1. 3.1.1.1. General requirements System overall description (level 1) (The following text is an excerpt from the GAS 6 Handboo
41、k, chap. VII, point 6.1.1 i. Minor changes have been made to achieve consistency with the remainder of this Recommendation.) This level of system description should provide a comprehensive overall introductory definition of a systems principal parameters, in sufficient detail so as to enable a compa
42、rison to be made between systems of the various suppliers. The system overall description should comprise “high level” descriptions of each of the following areas, as appropriate to a particular system: - Major functional partitioning of the system: - Features: Peripherals, network, controls, mainte
43、nance aids. Operational Subscriber (Complete list and description of each feature); Maintenance (Philosophy and features); Signalling Charging/Billing; Data. Subscriber line and inter-exchange circuits, size ranges; 0 Subscriber line and inter-exchange traffic capacity; Call processing capacity; Tra
44、fic performance; Blocking and load balancing. Peripherals, network, control; Mechanical design : racks, module frames (shelves), slide-in units, floor layout; Physical characteristics; Power. (Numbering, translations, routing, classes of service, trafic observation); (Subscriber, inter-exchange and
45、intra-exchange) ; - Size and capacity: - Technology: - Sofware-language, structure and modularity; - Environmental characteristics; - National/International Standards applicable: - Transmission characteristics; - Reliability; - Key-to-system specification and documentation structure. o Electrical/me
46、chanical/software/environment/reliability. Edition of May I 5, 1986 CEPT T/CS*OL-LO*E 4 m 232b434 0004453 m T/CS O1 -1 O E Page 9 3.1.1.2. Special requirements for software documentation Software documentation on system level should include: a general overview of the software system; a list of all s
47、ub-systems (e.g. for call processing, operation and maintenance) and a clear description of their functions; a short description of the inter-action principles of the sub-system. 3.1.2. Description of siib-systems/ftmctional blocks and special topics (level 2) 3.1.2.1. Sub-systems/fiinctional blocks
48、 This documentation should provide details of each major functional partition (sub-system/functional block), of the system. Examples of sub-systems/fiinctional blocks are: - hardware; the lineltrunk terminating modules; the systems processing unit(s); the switching network. the processor(s) operatin
49、g system(s); the software for alarm handling; the software for traffic statistics. - software: 3.1.2.1.1. General requirements O The sub-system description should indicate the implementation of the functional requirements in terms of the internal structure and logical processes of the system, as a whole. The realization of the functions/snb-systems in hardware, software and firmware as well as the inter-action and relationship of the constituent parts, be they hardware, software or firmware, shall be explained for each major area. The inter-actions betw
