top - download
⟦9002c5403⟧ Wang Wps File
Length: 15212 (0x3b6c)
Types: Wang Wps File
Notes: Package Design Spec. Guid
Names: »0776A «
Derivation
└─⟦872f87e0f⟧ Bits:30006013 8" Wang WCS floppy, CR 0052A
└─ ⟦this⟧ »0776A «
WangText
…02…CPS/AUX/010
…02…KNN/810421…02……02…#
PACKAGE DESIGN SPECIFICATION GUIDELINES
…02……02…CAMPS
This note presents the general guidelines to be fulfilled
by all package design specifications.
The note begins by presenting an outline to a table
of contents for package design specifications.
Next the structure of the PDS and the major PDS sections
are discussed in terms of contents and scope.
As this note represents general guidelines, which do
not address all package specialities, you are welcome
to contact me if you have any problems related to specification
of package design.
a) T̲a̲b̲l̲e̲ ̲o̲f̲ ̲C̲o̲n̲t̲e̲n̲t̲s̲ ̲O̲u̲t̲l̲i̲n̲e̲
The table of contents presented overleaf may be
expanded into sub-sections.
The sections listed are mandatory in all package
specifications. Sections which do not apply to
a package shall contain a N/A (not applicable).
PACKAGE DESIGN SPECIFICATION…01……01…TABLE OF CONTENTS OUTLINE
1 GENERAL
1.1 PURPOSE AND SCOPE
1.2 APPLICABLE DOCUMENTS AND PROJECT REFERENCES
1.2.1 APPLICABLE DOCUMENTS
1.2.2 PROJECT REFERENCES
1.3 TERMS AND ABBREVIATIONS
1.3.1 TERMS
1.3.2 ABBREVIATIONS
2 SUMMARY OF REQUIREMENT
2.1 PACKAGE DESCRIPTION
2.2 PACKAGE FUNCTIONS
2.2.1 MAIN FUNCTIONS (NORMAL OPERATION)
2.2.2 FUNCTIONAL RESPONSIBILITIES
2.2.2.1 INITIALIZATION, CLOSE DOWN, AND RESTART
2.2.2.2 CHECK POINTING AND RECOVERY
2.2.2.3 ERROR DETECTINg AND ERROR HANDLING
2.2.2.4 INTEGRITY OF OPERATION
2.2.2.5 DATA COLLECTION (LOG, STATISTICS, AND
REPORTS)
2.2.2.6 SECURITY
2.3 CHARACTERISTICS
2.3.1 TIMING
2.3.2 THROUGHPUT
2.3.3 FLEXIBILITY
2.3.4 ACCURACY
3 ENVIRONMENTS
3.1 EQUIPMENT
3.2 SOFTWARE
3.2.1 SYSTEM SOFTWARE
3.2.2 DEVELOPMENT SUPPORT SOFTWARE
3.3 INTERFACES
3.3.1 EXTERNAL INTERFACES
3.3.2 PACKAGE INTERFACE
3.4 FUNCTIONS MAINTAINED BY OTHER PACKAGES
4 PACKAGE DESIGN
4.1 PACKAGE OVERVIEW
4.1.1 FUNCTIONAL SPECIFICATION
4.1.2 SOFTWARE SPECIFICAION
4.1.3 DATA FLOW AND CONTROL LOGIC
4.1.4 PACKAGE DATA
4.1.5 COMMON DATA
4.1.6 INTERFACES
4.1.6.1 EXTERNAL INTERFACES
4.1.6.2 PACKAGE INTERFACES
4.1.6.3 SUB-PACKAGE INTERFACES
4.2.x SUB-PACKAGE SPECIFICATIONS
4.2.x.1 FUNCTIONAL SPECIFICATION
4.2.x.2 SOFTWARE STRUCTURE
4.2.x.3 DATA FLOW AND CONTROL LOGIC
4.2.x.4 SUB-PACKAGE DATA
4.2.x.5 SUB-PACKAGE INTERFACE
4.3 MEMORY LAYOUT
b) S̲t̲r̲u̲c̲t̲u̲r̲e̲ ̲o̲f̲ ̲t̲h̲e̲ ̲P̲D̲S̲
The PDS has been divided into four chapters. The
objectives for each chapter are presented below.
Chapter 1 shall contain a presentation (purpose
and scope) of the specification, define the baseline
documents and define terms/abbreviations used within
the specification.
Chapter 2 shall define the package functions and
characteristics to be implemented. The functions
shall be described at a level similar to the SRS
and SDS. Chapter 2 shall define what functions
are to be implemented and not how these are implemented.
Chapter 3 shall define what the package environments
are. How interfaces are implemented shall not be
described in chapter 3.
Chapter 4 shall contain the actual design which
implements the functional requirements described
in chapter 2 and 3.
It should be noted that chapter 2 and 3 of the
package specifications will be used to replace
the package definition in the SDS (section 5.x).
At package level section 4.1 of the package specification
is equivalent to chapter 4 of the SDS at system
level, while section 4.2.x of the package specification
is equivalent to section 5.x of the SDS.
c) S̲e̲c̲t̲i̲o̲n̲s̲ ̲a̲t̲ ̲t̲h̲e̲ ̲P̲D̲S̲
S̲e̲c̲t̲i̲o̲n̲ ̲1̲.̲1̲
a) Purpose Statement. Describe the purpose of
the Package Specification using the following
as a guide. The Package Specification for (Project
Name) (Project Number) is written to fulfil
the following objectives:
1) To provide detailed definition of the Package
functions and software architecture.
2) To provide user operational and development
personnel details of the ongoing analysis.
3) To define in detail the interfaces with
other packages and to describe their facilities.
b) Scope Statement. Descripe the scope of the
document by using the following as a guide.
1) What level of detail does the Package Specification
contain?
2) Where can higher/lower level design specifications
be found?
3) What interfaces/data are defined within
the specification and what interface/dates
are defined elsewhere?
S̲e̲c̲t̲i̲o̲n̲ ̲1̲.̲2̲
All documents which represent a baseline such as:
- CPS/210/SYS/0001
- CPS/ICD/XXX
- CPS/SDS/001
shall be defined.
Other documents which do not directly represent
CAMPS requirements shall be listed as reference
documents.
S̲e̲c̲t̲i̲o̲n̲ ̲1̲.̲3̲
This section shall contain a list of all abbreviations
and key terms pertinent to the document.
C̲h̲a̲p̲t̲e̲r̲ ̲2̲ ̲(̲G̲e̲n̲e̲r̲a̲l̲)̲
Chapter 2 and its sections shall specify requirements
pertinent to the package level.
The documentation in chapter 2 shall be able to
answer the following questions:
a) What am I part of?
b) What am I? (What are my functions?)
c) With whom do I interact?
C̲h̲a̲p̲t̲e̲r̲ ̲2̲ ̲(̲S̲p̲e̲c̲i̲f̲i̲c̲)̲
Section 2.1 shall contain a description of the
package and its inter-relationships with other
packages and/or system interfaces. A chart showing
the package and its inter-relationships shall be
resented.
Section 2.2 shall describe the function to be performed
by the package (on package level). The functions
to be described are basically those derived from
the SRS and the SDS.
Section 2.2.1 shall describe the function performed
under normal operation, while section 2.2.2 shall
describe the functions to be performed by the package
under special circumstances such as initialization,
recovery, security, etc.
Section 2.2.2 shall be seen in relation to section
3.4. It is important to distinguish between functions
which are performed by a package itself and functions
which are pertinent to a package, but performed
by other packages. Examples are log/statistics
collection and message check pointing.
Only functions performed by the package itself
shall be contained in section 2.2.2.
Section 2.3 shall specify the characteristics of
the packages which are timing, throughput, flexibility
and accuracy.
a) Timing. Describe any requirements for timing
on the package. The following requirements
should be considered:
1) Throughout time.
2) Response time to queries and for update
of data files.
3) Response time of major sub-system functions.
4) Sequential relationship of sub-system functions.
5) Priorities imposed by inputs or changes
in modes of operation.
6) Requirements for varying traffic load.
7) Sequencing and interleaving programs and
systems (including the ability to interrupt
a program without loss of data).
b) Throughput. Describe the processing capacity
(connectivity) of the package.
c) Flexibility. Describe the requirements for
the package to deal with changing situations
e.g. operational changes, and interaction with
new or improved systems. Identify those components
and procedures which may be subject to change.
d) Accuracy and Validity. Describe the requirements
for package accuracy. These requirements must
cover the following areas of concern:
1) Accuracy of input data.
2) Accuracy of transmitted data.
C̲h̲a̲p̲t̲e̲r̲ ̲3̲
Chapter 3 shall address the following four main
issues:
- equipment environment
- software environment
- package interfaces
- functions maintained by other packages
a) E̲q̲u̲i̲p̲m̲e̲n̲t̲ ̲E̲n̲v̲i̲r̲o̲n̲m̲e̲n̲t̲. Describe the equipment
required for the operation of the package,
and include a description of the equipment
presently available. Discuss the characteristics
of any additional equipment required. Related
the requirement for equipment to the requirements
stated in the SRS. The follwoing items should
be described:
1) Processor(s) (number of each on/off line
and size of internal storage).
2) Storage media (number of disk units, tape
units, etc.).
3) Input/output (I/O) devices (number of each
on/off line).
4) Communications net (line speeds).
b) The software environment has been separated
into the two categories:
1) System software
2) Development Software
The system software is defined to consist of
the following components DAMOS, IOC, CSF, and
SFM.
Other CAMPS software packages using these components
shall not specify their interfaces to these
packages (Refer below, section 3.3.2).
The development support software are defined
to include all software required to implement
and test the software package.
c) I̲n̲t̲e̲r̲f̲a̲c̲e̲s̲. Section 3.3.1 shall reference system
interfaces e.g. ICDs.
Section 3.3.2 shall identify interfaces to
other software packages (excl. DAMOS, IOC,
CSF, and SFM). The section shall not give a
detailed specification of interfaces, as these
are contained in section 4 of the PDS and in
separate ICDs.
d) F̲u̲n̲c̲t̲i̲o̲n̲s̲ ̲M̲a̲i̲n̲t̲a̲i̲n̲e̲d̲ ̲b̲y̲ ̲O̲t̲h̲e̲r̲ ̲P̲a̲c̲k̲a̲g̲e̲s̲
Section 3.4 shall contain a description of
functions which fulfil the following criterias:
1: functions performed by other packages which
have a major importance for the operation
of the package.
2: functions performed by other packages for
which there is no explicit interface. (supported
behind the users back")
Examples of functions to be described are:
- security functions
- check pointing function
- recovery functions
- log, statistics and report collection
- error detection and -handling
4̲ ̲ ̲P̲A̲C̲K̲A̲G̲E̲ ̲D̲E̲S̲I̲G̲N̲
4.1 P̲a̲c̲k̲a̲g̲e̲ ̲O̲v̲e̲r̲v̲i̲e̲w̲
Section 4.1 of the package specification has at package
level the same mission as chapter 4 in the SDS at system
level.
In total 4.1 gives the concurrent and sequential processing
within the package with clear definition of the role
of each sub-package which are described more detailed
in section 4.2.x.
4.1.1 F̲u̲n̲c̲t̲i̲o̲n̲a̲l̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲
This should be the first step in the analysis. The
package functions desolved in section 2.2.1 and 2.2.2
should be broken down to the level functional which
justifies allocation of the subpackages described further
in section 4.2.x.
̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
A B C
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲ ̲
Common functions
Where common functions exist within a package the functional
break-down shall be continued to the level where all
common functions can be isolated.
4.1.2 S̲o̲f̲t̲w̲a̲r̲e̲ ̲S̲t̲r̲u̲c̲t̲u̲r̲e̲
This section describes the allocation of functions
onto processes, shared procedures (between two processes),
monitor procedures (only for CSF, SSC, and DAMOS) or
co-routines.
Based on the above software component types sub-packages
shall be defined.
For each of the sub-packages the following elements
shall be contained.
1) Functions allocated to the subpackage (refer 4.1.1).
2) Software structure which corresponds with the functional
break-down of section 4.1.1.
The software structure shall be presented by a chart
which shows the software break-down. (Similar to chart
presented in section 4.1.1).
4.1.3 D̲a̲t̲a̲ ̲F̲l̲o̲w̲ ̲a̲n̲d̲ ̲C̲o̲n̲t̲r̲o̲l̲ ̲L̲o̲g̲i̲c̲
Data flow and control logic related to major transaction
within a package shall be described to the sub-package
level.
The functional flow must give the normal flow (as 2.2)
and the special flow (2.3).
The tools to document flow/logic are block diagrams
for process synchronization/communication and HIPO
for sequential processing.
4.1.4 C̲o̲m̲m̲o̲n̲ ̲D̲a̲t̲a̲ ̲E̲l̲e̲m̲e̲n̲t̲s̲ ̲(̲I̲n̲t̲e̲r̲n̲a̲l̲)̲
This should identify common data element (but not give
detailed layout in order to make 4.1.5 more readable).
4.1.5 E̲x̲t̲e̲r̲n̲a̲l̲ ̲D̲a̲t̲a̲ ̲E̲l̲e̲m̲e̲n̲t̲s̲
This should identify data shared with other packages
which are defined in Data Def. Doc.
4.1.6 I̲n̲t̲e̲r̲f̲a̲c̲e̲s̲
The section shall define external interfaces as well
as software package to package interfaces (excl. DAMOS,
IOC, CSF, and SFM). At minimum shall be references
to the appropriate ICDs shall be included.
Sub-package interfaces shall, furthermore, be identified
but not specified in details, as this shall take place
in section 4.2.x.5.
G̲e̲n̲e̲r̲a̲l̲ ̲C̲o̲m̲m̲m̲e̲n̲t̲s̲ ̲t̲o̲ ̲4̲.̲1̲.̲4̲,̲ ̲4̲.̲1̲.̲5̲,̲ ̲a̲n̲d̲ ̲4̲.̲1̲.̲6̲
In order to obtain a selfcontained and readable document
it may be necessary to include detailed information
in section 4.1.4 - 4.1.6. It shall however be emphasized
that the master source for definition of data and package
interfaces are the CAMPS data definition document and
the CAMPS software interface control document.
4.2.x S̲u̲b̲-̲p̲a̲c̲k̲a̲g̲e̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲s̲
This section shall expand the subpackage design, as
described in section 4.1 to a level where all modules
(less than 250 source statements, refer SRS) are identified
and the functions defined.
4.2.x.1 F̲u̲n̲c̲t̲i̲o̲n̲a̲l̲ ̲S̲p̲e̲c̲i̲f̲i̲c̲a̲t̲i̲o̲n̲
This section shall contain a functional break-down
to such a level that all SW modules can be identified
taken all functional areas defined in section 2.2 and
4.1.1 into account.
4.2.x.2 S̲o̲f̲t̲w̲a̲r̲e̲ ̲S̲t̲r̲u̲c̲t̲u̲r̲e̲
This section shall contain a description which identifies
all software components to be implemented (Refer 4.1.2).
4.1.x.3 D̲a̲t̲a̲ ̲F̲l̲o̲w̲ ̲a̲n̲d̲ ̲C̲o̲n̲t̲r̲o̲l̲ ̲L̲o̲g̲i̲c̲
Data flow and control logic related to major transactions
within a subpackage shall be described.
The mandatory tool to specify flow/logic is HIPO for
sequential processing. Where functions are made up
of complex algorithms or decisions the HIPO charts
may be supplemented by flowgrams and/or decision table.
Where concurrent procesisng exist blockdiagrams shall
be used to specify communication between software components.
4.2.x.4 S̲u̲b̲p̲a̲c̲k̲a̲g̲e̲ ̲D̲a̲t̲a̲
This section shall define data which are pertinent
to the sub-package only. Package data or common data
shall be defined in 4.1.4 and 4.1.5.
4.2.x.5 I̲n̲t̲e̲r̲f̲a̲c̲e̲s̲
This section shall specify interfaces between subpackages
within the package. Package interfaces or external
interfaces shall be defined in the appropriate ICDs
and referenced/defined in section 4.1.6.
