top - download
⟦062b2be0b⟧ Wang Wps File
Length: 22714 (0x58ba)
Types: Wang Wps File
Notes: Protocol Converter
Names: »1855A «
Derivation
└─⟦674a3d0c4⟧ Bits:30006239 8" Wang WCS floppy, CR 0622A
└─ ⟦this⟧ »1855A «
WangText
…02…
…02…JPR/820319…02……02…
PROTOCOL
CONVERTER
SYSTEM
REQUIREMENTS
SPECIFICATION…02……02…PC
10. D̲O̲C̲U̲M̲E̲N̲T̲A̲T̲I̲O̲N̲ ̲R̲E̲Q̲U̲I̲R̲E̲M̲E̲N̲T̲S̲
10.1 G̲e̲n̲e̲r̲a̲l̲
a) Hardware documentation developed by CR under this
contract will be produced in accordance with the
requirements as stated in this section of the System
Requirements Specification. Documentation for
OEM equipment will be delivered according to the
requirements as stated in the contract.
b) Software documentation developed by CR under this
contract will generally be produced in accordance
with the structure of ACE directive 007-3 issue
2.
c) This appendix D of the contract will serve as the
System Requirements Specification
10.2 F̲o̲r̲m̲a̲t̲ ̲a̲n̲d̲ ̲P̲u̲b̲l̲i̲c̲a̲t̲i̲o̲n̲ ̲C̲r̲i̲t̲e̲r̲i̲a̲
All documentation delivered by the contractor shall
be prepared in accordance with the following requirements.
10.2.1 P̲a̲p̲e̲r̲
The documents, exclusive of covers, shall be printed
on a good grade of white paper of sufficient weight
and substance to permit printing on both sides. The
paper size will be DIN A4. The paper used for fold-out
drawings shall be of a quality and thickness that permits
repeated opening and folding without cracking or tearing
at the folds.
10.2.2 B̲i̲n̲d̲i̲n̲g̲
a) The documents shall be bound between hardbacked
covers that incorporate a metal binding system
which will permit easy removal and insertion of
pages, photographs, illustrations and drawings
and which will permit the documents to lie flat
when opened at any page.
b) The information on pull-out sheets bound in the
hard-backed covers shall be positioned so that
it is clear of the text of its associated document
when opened up so that the reader can readily cross-refer
between text, drawings and illustrations.
c) If they are not accountable items for security
reasons, excessively large drawings may be placed
in pockets formed in the rear covers of binders,
or in the case of, as-built and installation instructions,
to contain large drawings in separate folders equipped
with a fastening arrangement to prevent accidental
loss and spillage of the contents.
d) The cover and title page of the document shall
show the classification of the document, manufacturer
of the equipment, number of the document and its
issue number, number of the contract and the date
of issue. In the case that a subject is covered
in more than one volume then an indication of the
contents of each manual shall be shown. The title
and number of the document shall also be shown
on the spine of the cover if applicable.
10.2.3 N̲u̲m̲b̲e̲r̲i̲n̲g̲
a) The pages of Sections and Chapters are to be separately,
and sequentially numbered beginning with the number
one in each case, with the associated Section or
Chapter number added as a prefix. The page numbers
are to be inserted at the centre of the lower margin
above the classification, or in the appropriate
box if preprinted formsheets are used.
b) Paragraphs, sub-paragraphs, and sub-sub-paragraphs,
are to be numbered sequentially commencing with
one, and sub-paragraphs are to have the associated
paragraph number added as a prefix (i.e. 1.1.,
1.2., 1.3., etc.) and sub-sub-paragraphs, the associated
sub-paragraph number added as a prefix (i.e. 1.1.1.,
1.1.2., 1.1.3. etc). The maximum depth will be
4 (i.e. 1.1.1.1) unless otherwise agreed.
c) For sub-divisioning identification, lower-case
alphabetical characters enclosed in half brackets
shall be used (i.e. a), b), c), etc.). For Sub-sub
divisioning, upper-case Arabic numerals enclosed
in half brackets shall be used (i.e. 1), 2), 3),
etc).
d) Tables shall be captioned and allocated a Table
Number having the Section or Chapter number as
appropriate added as a prefix (e.g. Table 1.1).
Tables may be included as a part of the text or
printed on a fold-out sheet. When printed on a
fold-out sheet, the table number must be positioned
on the fold-out portion so that it is visible on
opening the document to which it belongs.
10.2.4 P̲r̲e̲f̲a̲c̲e̲
a) Each separately bound document (manual) shall commence
with a set of introductory pages, and when a manual
or set of documentation consists of only one separately
bound document, the introductory pages shall consist
of the following:
1) Title pages with the security classification
of the handbook, manufacturer of the equipment,
number of the handbook and its relevant issue
number, number of the relevant contract and
date of issue.
2) When applicable, instructions covering treatment
for electric shock.
3) Amendment history sheet.
4) Record of modifications to the equipment.
5) Introduction giving the purpose of the handbook
and instructions for its use.
6) Table of contents listing the titles of all
sections, headings and sub-headings, together
with relevant paragraph and page numbers.
7) Detailed list of all tables together with relevant
table and page numbers.
8) Detailed list of all drawings, illustrations
and photographs together with a relevant reference
and page numbers.
9) Legend explaining all abbreviations and symbols
used in the text and on the drawings.
10) Photographs or drawings of the major items/bays
described in the handbook.
b) When a manual or set of documentation consists
of more than one volume, each separately bound
volume, section or part, shall contain a set of
introductory pages as described, plus an additional
page inserted after the front sheet containing
an abbreviated list of contents for the complete
manual or set of documentation, as applicable.
c) Wherever possible, photographs, drawings and illustrations
shall be bound in the same cover as the associated
text. In addition when a manual or set of documentation
consists of more than one separately bound document
the first document of the series shall be identified
as the master document and shall contain all information
of a general nature applicable to all documents
of the series.
10.2.5 P̲r̲i̲n̲t̲i̲n̲g̲ ̲a̲n̲d̲ ̲T̲y̲p̲e̲
A conventional typewriter font shall be employed for
the printing of all letters and figures in the text
of all documents.
All titles and headings shall be underlined.
10.2.6 L̲a̲n̲g̲u̲a̲g̲e̲
All documents shall be written in the English language.
All descriptions shall be written in a clear and precise
manner, using unambiguous English and a minimum of
words. Wherever feasible descriptions and procedures
shall be supported either by diagrams and photographs
or other types of illustrations to facilitate understanding
of the text by personnel having only a working knowledge
of the English language.
10.2.7 S̲e̲c̲u̲r̲i̲t̲y̲ ̲C̲l̲a̲s̲s̲i̲f̲i̲c̲a̲t̲i̲o̲n̲
Manuals and documents shall be classified in accordance
with the classification of the information included
therein. The relevant classification of a document
shall be printed at the centre top and bottom of all
pages, photographs, illustrations and drawings, and
at the centre top and bottom of the front cover of
all binders. The highest classification of any section
of a document shall be printed on the cover of that
binder.
Applicable document for security classification is
NATO Document CM(55)15 Final "Security within the North
Atlantic Treaty Organization".
10.2.8 P̲h̲o̲t̲o̲g̲r̲a̲p̲h̲s̲,̲ ̲I̲l̲l̲u̲s̲t̲r̲a̲t̲i̲o̲n̲s̲ ̲a̲n̲d̲ ̲D̲r̲a̲w̲i̲n̲g̲s̲
a) All titles and included text and annotations shall
be in the English language in addition to any other
language that may be employed. To facilitate correlation
the figure numbers are to be preceded by the associated
chapter or section number as appropriate (e.g.
Figure 1.1).
b) The lettering and layout of drawings shall be in
accordance with recognized industrial or national
standards. Hand lettering shall be avoided except
on advance information copies and for marking-up
ATBB documents during site implementation.
c) Symbols, when employed, shall be defined so that
there can be no confusion in their interpretation.
The definitions may, at the discretion of the contractor,
be given on the drawings or collectively in the
associated document in the form of a glossary.
d) The use of drawings and illustrations that exceed
1 x 1.5 metres shall be avoided. Where necessary
the scale shall be shown.
10.2.9 A̲m̲e̲n̲d̲m̲e̲n̲t̲s̲
The contractor shall be responsible for the issue,
control and distribution of amendments to all delivered
documents, resulting from changes and/or modifications
in the equipment or spare parts, until expiration of
the warranty period for the associated equipment. In
the case of the training documentation the contractor
shall be similarly responsible until the end of the
training period.
10.2.11 U̲s̲e̲ ̲o̲f̲ ̲R̲e̲f̲e̲r̲e̲n̲c̲e̲s̲
To avoid duplication of information references to other
parts of the documentation may be made.
10.3 A̲p̲p̲r̲o̲v̲a̲l̲ ̲a̲n̲d̲ ̲D̲e̲l̲i̲v̲e̲r̲y̲
Approval and delivery of documentation will be in accordance
with paragraph 15 Special Provisions under this contract
unless otherwise agreed or stated in this section.
a) Three months before the provisional site acceptance
(PSA) of the first site four copies of each draft
document shall be submitted to the purchaser for
review. The resulting recommended changes shall
be considered and incorporated by the contractor
who shall re-submit one copy of the revised document
for printing approval. Upon receipt, in writing
from the
purchaser, that the contents of the revised version
contain all of the purchaser's recommended correcti-
ons, changes and comments to his satisfaction,
the contractor shall be responsible for the editing,
production and delivery of the required number
of the documents. The contractor shall provide
page changes or if necessary shall re-issue portions
of the documents whenever changes/modifications
in equipment or spare parts are made.
b) In the event that approved copies are not available
at the time of on-site acceptance test of equipments,
preliminary version of each document (advance information
in sufficient detail to permit satisfactory operation
and maintenance of the equipment) shall be provided
to each site at the time of the provisional site
acceptance.
c) Q̲u̲a̲n̲t̲i̲t̲i̲e̲s̲
The contractor shall deliver the following quantities
of handbooks (i.e. Equipment, maintenance and Test
Equipment Handbooks).…06…1 …02… …02… …02… …02…
T̲O̲ D̲R̲A̲F̲T̲ ̲P̲R̲E̲L̲I̲M̲I̲N̲A̲R̲Y̲ ̲V̲E̲R̲S̲I̲O̲N̲ F̲I̲N̲A̲L̲ ̲V̲E̲R̲S̲I̲O̲N̲
Each Site 0 2 (each) (Delivery
2
weeks
before
PSA)
Purchaser 4 (each) Delivery 3 months 5 (each)
"
before PSA of first site
10.4 E̲q̲u̲i̲p̲m̲e̲n̲t̲ ̲H̲a̲n̲d̲b̲o̲o̲k̲s̲
10.4.1 C̲R̲ ̲P̲r̲o̲d̲u̲c̲e̲d̲ ̲E̲q̲u̲i̲p̲m̲e̲n̲t̲
Equipment handbooks shall be prepared for all main
and miscellaneous equipment supplied. The equipment
handbook shall contain as a minimum:
a) Equipment Specifications.
b) Installation and Commissioning Instructions.
c) Operating Instructions.
d) Technical Description.
e) Parts Lists.
10.4.1.1 E̲q̲u̲i̲p̲m̲e̲n̲t̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲s̲
a) This section shall contain a listing of all the
important parameters of the described equipment.
It shall include but not be limited to the following:
b) The required external power supply voltage and
frequency characteristics with acceptable tolerances.
c) Power consumption, ventilation and environmental
control data.
d) Characteristics and acceptable tolerances of all
input and output signals.
e) The environmental conditions over which the equipment
performance will continue to meet the design performance
criteria.
f) The overall weight and the weight of each typical
unit or sub-unit.
g) The overall dimensions and the dimensions of each
major unit or sub-unit.
10.4.1.2 I̲n̲s̲t̲a̲l̲l̲a̲t̲i̲o̲n̲ ̲a̲n̲d̲ ̲C̲o̲m̲m̲i̲s̲s̲i̲o̲n̲i̲n̲g̲ ̲I̲n̲s̲t̲r̲u̲c̲t̲i̲o̲n̲s̲
a) This section shall include the electrical and mechanical
information necessary for mounting and demounting
the equipment especially:
b) Detailed mechanical installation instructions.
c) Detailed external and inter-unit cabling instructions,
including earthing connections.
d) Specification of the cables to be used.
e) A detailed list of checks to be carried out prior
to application of power for the first time.
f) A detailed list of checks to be carried out following
the application of power and prior to putting the
equipment into service. Where these checks are
identical to the maintenance procedures references
shall be made to the maintenance procedures. Duplication
of the text is not required.
g) List of tools and test equipment required for installation,
commissioning and check-out of the equipment.
10.4.1.3 O̲p̲e̲r̲a̲t̲i̲n̲g̲ ̲I̲n̲s̲t̲r̲u̲c̲t̲i̲o̲n̲s̲
a) The operating instructions shall be detailed and
cover all applicable equipment both central computer
and peripherals.
b) Operating instructions shall include the basic
functions such as:
1) Power ON and OFF.
2) Emergency power OFF.
3) Interpretation of alarm and warning conditions
and associated immediate action instructions.
4) Description of controls and indicators.
c) A user's manual will be written for the following
user categories:
1) Maintenance technician.
d) The user's manual will describe all the operator
functions of the Converter and illustrate how it
is operated.
10.4.1.4 T̲e̲c̲h̲n̲i̲c̲a̲l̲ ̲D̲e̲s̲c̲r̲i̲p̲t̲i̲o̲n̲
a) The depth of description will be in accordance
with the level of maintenance as outlined in contractor's
maintenance plan.
b) First section will give a general introduction
to the equipment and explain its purpose. It shall
give a brief description covering the overall physical,
electrical and electronic characteristics as applicable,
using as back-up information block diagrams, photographs
or other suitable illustrations.
c) Subsequent sections will describe the major elements
and assemblies, and present the overall functional
description of the system.
d) The object of the Technical Description is to provide
sufficient technical information to operating and
maintenance personnel to enable them to understand
and use the Maintenance Handbooks and Operating
Instructions respectively.
10.4.1.5 P̲a̲r̲t̲s̲ ̲L̲i̲s̲t̲
This section shall consist of a tabulation following
a "family tree" type breakdown of all parts for the
described equipment, and shall provide the following
information.
a) Manufacturer's part number and an associated brief
descriptive phrase for each major assembly.
b) The component reference number as used on the
circuit diagrams for all electrical/electronic
components parts. Each reference number shall
be followed by a brief descriptive phrase,
nominal value, rating and tolerance of the
associated component, together with the manufacturer's
reference number and manufacturer's address
or NATO code (if readily available).
c) Manufacturer's part number and an associated
brief descriptive phrase for each mechanical
part, together with the manufacturer's address
for each item listed.
d) A list of the sizes and types of nuts, bolts,
washers and fasteners supplied as a repair
kit to each site and depot.
10.4.2 O̲E̲M̲ ̲E̲q̲u̲i̲p̲m̲e̲n̲t̲
Handbooks and other relevant documentation for peripherals
and test equipment supplied shall be delivered in accordance
with the terms of the contract; i.e. standard OEM documentation.
10.5 M̲a̲i̲n̲t̲e̲n̲a̲n̲c̲e̲ ̲H̲a̲n̲d̲b̲o̲o̲k̲
The maintenance procedures handbook is the basic document
which outlines how the maintenance of the system will
be effected. It shall be, in effect, the final version
of the contractor's maintenance plan. It shall be the
one document which will give precise instructions to
a technician as to how he will fulfil his responsibilities.
Drawings, illustrations and photographs used in connection
with maintenance will permit identification of the
location of all replaceable units to permit a technician
to repair and to satisfactorily maintain the equipment.
Equipment layout drawings, inter-unit and sub-unit
cabling and wiring diagrams shall be provided for all
electrical and electronic assemblies. Annotated line
drawings, annotated cut-away illustrations, and annotated
photographs, as appropriate, shall be provided to permit
identification of all mechanical assemblies and mechanisms
and parts thereof. As a minimum the following drawings
shall be included:
a) Block diagram of the whole equipment.
b) Block diagram of assemblies divided into units.
c) Block diagram of major units.
d) Detailed interconnection diagrams and internal
cabinet cabling diagrams including the views of
plug-in connectors.
10.5.1 P̲r̲e̲v̲e̲n̲t̲i̲v̲e̲ ̲M̲a̲i̲n̲t̲e̲n̲a̲n̲c̲e̲
The preventive maintenance instructions shall contain:
a) All recommended routine maintenance tasks necessary
to ensure continuous and satisfactory performance
of the equipment, based on the periodicity of maintenance
(i.e. daily, weekly, monthly etc.).
b) Illustrations and test set up schematics shall
be included to ensure that the procedures can be
understood by the technician.
c) All test points clearly identified. The nominal
values and the acceptable limits that should be
measured at each test point shall be indicated.
d) The document shall include system and sub-system
alignment procedures.
e) Where necessary, reference shall be made to other
documentation where more detailed information regarding
the maintenance task may be found.
f) List of all required tools and test equipment supplied
for maintenance purposes.
g) Dismantling and re-assembly instructions shall
be given where applicable.
10.5.2 C̲o̲r̲r̲e̲c̲t̲i̲v̲e̲ ̲M̲a̲i̲n̲t̲e̲n̲a̲n̲c̲e̲
The corrective maintenance instructions supplied to
each site will reflect the level of maintenance applicable
to the converter, i.e. module replacement.
The corrective maintenance instructions shall contain:
a) Detailed descriptions of the symptoms of a fault
to include alarm conditions if applicable.
b) Description of the possible fault isolation methods
and tools used in connection with fault isolation.
c) Comprehensive procedures for fault tracing and
fault isolation.
10.5.3 A̲s̲s̲o̲c̲i̲a̲t̲e̲d̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲a̲t̲i̲o̲n̲
Appropriate documentation, either in the form of the
manufacturer's handbook or leaflet, shall be provided
where applicable for each delivered item of test equipment.
Similarly, documentation shall be provided for those
tools, other than simple hand tools, which require
operation and maintenance instructions, when full information
is not given in the Maintenance and Operating Manual.
10.6 E̲n̲g̲i̲n̲e̲e̲r̲i̲n̲g̲ ̲D̲r̲a̲w̲i̲n̲g̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲a̲t̲i̲o̲n̲
10.6.1 C̲i̲v̲i̲l̲ ̲W̲o̲r̲k̲s̲ ̲R̲e̲q̲u̲i̲r̲e̲m̲e̲n̲t̲s̲
The civil works requirements are to be provided by
contractor prior to equipment installation at each
site. This document should, as a minimum, be in the
form of engineering sketches and written text describing
all civil works that need to be accomplished to prepare
the site for contractor equipment installation. This
documentation must be in sufficient technical detail
to instruct a civil works contractor in the work to
be performed.
10.6.2 A̲s̲-̲t̲o̲-̲b̲e̲-̲B̲u̲i̲l̲t̲ ̲a̲n̲d̲ ̲A̲s̲-̲B̲u̲i̲l̲t̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲a̲t̲i̲o̲n̲
a) This documentation shall provide full details of
how all the major assemblies of the supplied equipment
at each location have been physically installed
and electrically integrated. They will be supplied
by CR as two deliveries:
1) As-to-be-Built drawings.
2) As-Built Drawings (due at time of PSA).
10.7 I̲n̲v̲e̲n̲t̲o̲r̲y̲
10.7.1 G̲e̲n̲e̲r̲a̲l̲
The contractor shall prepare a property inventory for
each site.
10.7.2 P̲r̲o̲p̲e̲r̲t̲y̲ ̲I̲n̲v̲e̲n̲t̲o̲r̲y̲
a) The contractor shall prepare a property inventory
of each site and shall deliver them to the related
sites before provisional site acceptance (PSA).
b) The inventory shall be prepared in block form and
shall consist of the following sections, as applicable:
1) Main Equipment.
2) Test Equipment.
3) Spare Parts (Site and Depot).
4) Installation Material (Cable and Hardware).
5) Documentation.
c) The inventory information, shall include as a minimum
the following data elements:
- Site
- Item Number
- Description
- True Manufacturer's Part Number
- Manufacturer's Identification Code
- Quantity
- Price
- NATO Stock Number (as available)
- Item Serial Number (for test equipment and
for major assemblies)
- Working or Spare
- Remarks
e) The inventory shall be checked against the installed
equipment at time of PSA and changed as necessary.
The marked up copy shall then form the official
record of all equipment and other items that have
been delivered. The deliverable final inventory
will be submitted in the form of a hard copy list
subsequent to SPA.
10.8 S̲o̲f̲t̲w̲a̲r̲e̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲a̲t̲i̲o̲n̲
10.8.1 G̲e̲n̲e̲r̲a̲l̲
CR will produce software documentation in accordance
with ACE directive 007-3 issue 2, dated 14th January
1980.
10.8.2 D̲o̲c̲u̲m̲e̲n̲t̲a̲t̲i̲o̲n̲ ̲S̲t̲r̲u̲c̲t̲u̲r̲e̲
The software documentation shall be structured in a
hierarchical system of levels in accordance with the
hierarchical structure of the software.
The software shall be documented in 2 levels:
- Software Specifications (System level)
- Package Specifications
10.8.3 S̲o̲f̲t̲w̲a̲r̲e̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲ ̲(̲S̲y̲s̲t̲e̲m̲ ̲L̲e̲v̲e̲l̲)̲
The software shall be specified as follows:
a) System software shall be documented in accordance
with CR internal standard for System Software.
b) The application software shall be specified in
accordance with ACE Directive 007-3 Annex C Subsystem
Specification.
10.8.4 P̲a̲c̲k̲a̲g̲e̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲s̲
The application software subsystems shall be broken
down into software packages with well defined functions
and interfaces. The Application software package shall
be specified in accordance with ACE Directive 007-3
Annex D "Program Specification".
