Transcript Software Design Specification (SDS)

Table of Contents for the SDS
(Software Development Specifications)
1.0 Introduction- ( Extensions of SRS)
1.1 Purpose
1.2 Scope
1.3 Definition and Acronyms
`
1.4 References ( extensions of SRS)
1
Table of Contents for the SDS
(Software Development Specifications)
2.0
Decomposition Description (part 1)
2.1 Preliminary Design of Architecture
2.2 GUI Components with layouts, navigation
2.3 Database Components –
Database Tables, Segments, or Objects
2.4 Data Dictionary
attributes, database components, GUI components2
Table of Contents for the SDS
(Software Development Specifications)
2.1 Preliminary Design of Architecture
Client
Environment
Server
Environment
SNA Server(COMTI)
TCPIP
CICS Trans
T1 Line
TCPIP
MSMQ Messages
T1/transactions
Twisted Pair
Compaq Server
NT
Visual Basic
MSMQ
SNA Server (COMTI)
Compaq PC
NT
Visual Basic …..
Access
Crystal
Reports
DB Server
Environment
SQL - 7
Mainframe IBMXXX
MVS
CICS
Cobol Programs
IMS
Hand
Readers
Cameras
VB Screens
3
Table of Contents for the SDS
(Software Development Specifications)
2.2 GUI Components with layouts, navig.
4
Table of Contents for the SDS
(Software Development Specifications)
2.2 GUI Components with layouts, navig.
Navigation Table
State
File Menu
Open
Close
New
Key FileName
Resulting State
OpenDialogue
Close Dialogue
New SpreadSheet
New SpreadSheet
……
…….
5
Table of Contents for the SDS
(Software Development Specifications)
2.0
Decomposition Description (part 1)
2.3 Database Components –
Database Table Definitions
Database Table Classes Definitions
Database Definition
6
Table of Contents for the SDS
(Software Development Specifications)
2.4 Data Dictionary
attributes, database components, GUI components
Entries for every table,
every screen (no in design terms)
7
Table of Contents for the SDS
(Software Development Specifications)
3.0 Decomposition Description (cont’)
3.1 Component, Module or Item 1
Preliminary Description
Class Diagram at the design level ( iterative)
3.2 Component, Module or Item 2 Prelim Desc
Sequence Diagram (iterative)
3.3
Data Dictionary
with attributes, classes, sequence diagrams
8
Table of Contents for the SDS
(Software Development Specifications)
3.1 Component, Module or Item 1Preliminary Description
Class Diagram at the design level ( iterative)
Enroll Customer
Return Video
Database Class
Rent Video
Rent Video View
Movie View(s)
Movie
Movie Table
movieID: int
Party View(s)
movieName: String
orderMovie()
Cassette
Rental
Party
Rental View (s)
cassetteID: int
CID: int
cassetteID: int
customerID: int
name:
String
authenticate
Customer ()
Party Table
cassetteVolumeNo: int
dateRented: date
rentMovie()
rentMovie()
Rental Table
Cassette Table
9
Table of Contents for the SDS
(Software Development Specifications)
3.2 Component, Module or Item 2 Prelim Desc
Sequence Diagram (iterative)
System
Border
Customer selects “process promotion
order” option
Do until no more member orders
Customer enters member number
Main
Window
Start
Order
Processing
Window
Order
Processer
Member
Member
Order
Member
Ordered
Product
Product
Start order
process
Request member number
New member number
Validate member
number
isMember
If member number valid
Get current promtion order header
reportOrder
Do until no more ordered products
Get ordered product information
Get product information
Display order
reportOrderedProduct
reportProduct
Display order
Else
Display error message
Clear Message
Display error message
Clear
Endif
10
Table of Contents for the SDS
(Software Development Specifications)
4.0 Component Detail Design Document
4.1
Component, Module 1,or Item 1 – FOR EACH CLASS
4.1.1 Structure - supertype and sub types of this class
4.1.2 Function –methods of classes with signatures
4.1.3
Interfaces- collaborating classes
4.1.4 Program Interrupts – N/A
4.1.5 Timing and Sequencing N/A
4.1.6 Sequential Control Feature - N/A
4.1.7
Storage Allocation - where class housed (c/s)
4.1.8 Application Data – the attributes for each class
4.1.9
Detailed Design Description
Narrative description of each each method.
4.2
Component or Module 2 - class 24.3
………..
11
4.n Component or Module n – class 4
At this point you would have to replan.
But we will not include this in our SDS.
But you would have needed to schedule the
programmers, the database analysts, the database
builders, the people who are doing the html if needed the
javascript if needed ect.
So I left this in here to make me remember to tell you
about the fact that a new plan would need to be done.
But we will not do the plan.
To schedule all the programming staff. While a little
project would not be a problem a large one might even
hire a different contractor at this point.
12
Table of Contents for the SDS
(Software Development Specifications)
I. Introduction
Summary of Contents of SDP document
Scope and Purpose of SDP Document
System Level Project Description
System Description
13
Table of Contents for the SDS
(Software Development Specifications)
Summary of Contents of SDP document
TOC
Scope and Purpose of SDP Document
This document will be used to plan project
…. Or get funding….. Or write the RFP
System Level Project Description
This project will…….
System Description
This system will
14
Table of Contents for the SDS
(Software Development Specifications)
2. Resources and Scheduling
How many people needed?
What type of people?
How long will it take to do this project?
How long will each person be needed?
15
Table of Contents for the SDS
(Software Development Specifications)
2. Resources and Scheduling
This project will need x# users, y# dp staff
There will be one communications
specialist, one data specialist, one unix specialist,
one capacity manager, one xxxxx user 4
managers, …..
This project will begin …. And end …..
Person A needed during weeks of etc
16
Table of Contents for the SDS
(Software Development Specifications)
3. Organization and Staffing
Who are the people needed?
How will the Staffing be organized
How are the users organized?
Who pays? Who knows?
17
Table of Contents for the SDS
(Software Development Specifications)
3. Organization and Staffing
The organizational chart for the
project will be as follows:
Contractor will pay for travel,
meeting rooms…...
18
Table of Contents for the SDS
(Software Development Specifications)
4. WBS (Work BreakDown Schedule)
Week by week, who will be needed
and when?
How much time will be devoted?
How much will this cost?
19
Table of Contents for the SDS
(Software Development Specifications)
4.
Wk1
Wk2
Wk3
John
5 hrs
40 hrs
30 hrs
Mary
3 hrs
35 hrs
24 hrs
Analysis
…...
20
Table of Contents for the SDS
(Software Development Specifications)
5. Technical Management and Control
How will change management be done?
How will risk be managed?
How will cost be contained?
How will issues be resolved?
21
Table of Contents for the SDS
(Software Development Specifications)
5. Technical Management and Control
Changes to specification will be done by submitting a change report,
approval of change by xyz committee, and scheduling of change.
Risk will be reviewed by the xyz committee each month. Formal risk
reports are due to jkl committee quarterly.
Cost reports will be given to mno committee each week for review by
xxx manager.
All issues will be reviewed at the project management meeting. Issues
which delay development schedules will be resolved by the rst
committee.
22
Table of Contents for the SDS
(Software Development Specifications)
6. Standards and Procedures
What deliverable standard will be used
What development methodology?
What is the deliverable standard?
23
Table of Contents for the SDS
(Software Development Specifications)
6. Standards and Procedures
Deliverables will be prepared according to the
Summit methodology. All deliverables will be
submitted using standard UML. Deliverables
will be reviewed by the developers and upon
approvals users, management committee,
steering committee and final signature by
project sponsor.
24
Table of Contents for the SDS
(Software Development Specifications)
7. Reviews, Audits, and Walkthroughs
How will deliverables be reviewed?
Who will perform auditing?
Who will perform walkthroughs?
What is the approval process?
25
Table of Contents for the SDS
(Software Development Specifications)
Software Reviews
Design Reviews
Design and Coding Checks
Management Reviews
Project Checkpoints concerned with costs, plans, schedules
Quality Reviews
Technical reviews of quality of deliverable products,
standards adherence, documentation
End Product of Reviews
No Action, Refer for Repair, Reconsider overall product
26
Table of Contents for the SDP
(Software Development Plan)
Software Reviews
Design Reviews will be conducted for adherence of good
use of design patterns, and reuse.
Management Reviews
Project Checkpoints will be done weekly for cost control and
schedule deadline control.
Quality Reviews
Technical reviews will be conducted at the end of each phase
for the quality of deliverable products, standards adherence,
and documentation
End Product of Reviews
End of product reviews will be conducted informally on demand.
27
Table of Contents for the SDP
(Software Development Plan)
8. Development Environment
What will be the development hardware/
software. This includes mainframes, PC’s,
mini’s, input/output devices, communications
devices, database software, operating systems,
communications software, and other items of
need for development
28
Table of Contents for the SDP
(Software Development Plan)
8. Development Environment
The system will be developed using
the IBM 3090 mainframe running AIX
and Dell Pentium micro computers
running windows NT. The development
environment will be the same except
micros will run windows 95.
29
Table of Contents for the SDP
(Software Development Plan)
9. Technical Performance Measurements
How fast will response time be?
How fast will database access be?
How many transactions per sec?
How many terminals on at one time?
What is the MTBF?
30
Table of Contents for the SDP
(Software Development Plan)
Performance Evaluation
Number of simultaneous users
Number of Connections
Number of Files
Size of Tables
Number of Open Files
Number of Records
Number of Transactions per interval
Response Time
Amount of data processed in a time unit Database Accesses per time unit
Reliability
Availability
Backup/Recovery
CPU Utilization
Memory Utilization
I/O Channel Utilization
Software Utilization
Terminals Supported
External Devices Supported
31
Table of Contents for the SDP
(Software Development Plan)
9. Technical Performance Measurements
Each transaction will have < 10 sec response time.
Each database will be completed within 10 ms.
The system will process 600 transactions per sec
with 4500 terminals on line.
MTBF will be > 1 hour on the average.
32
Table of Contents for the SDP
(Software Development Plan)
10. Documentation
Documentation for technical deliverables,
administrative reporting, memos,
minutes, meetings, decisions, outstanding
issues.
33
Table of Contents for the SDP
(Software Development Plan)
10. Documentation
Documentation will be held for all
paperwork and decisions. IEEE standard
deliverables of the waterfall model will be used
for administrative reports. UML will be used to
document all technical deliverables. All
meetings will be recorded and saved. All
decisions will be documented and outstanding
issues will be updated every week.
34
Table of Contents for the SDP
(Software Development Plan)
11. Verification and Validation
How the system will be verified and
validated to assure it is the right system
and is developed correctly. The
techniques will be spelled out for HOW
this system V&V will be conducted.
35
Table of Contents for the SDP
(Software Development Plan)
11. Verification and Validation
Deliverables will be verified for
conformance with standards using by the
QA group. Deliverables will be validated
by the xxx user and yyy development
committees
36
Table of Contents for the SDP
(Software Development Plan)
12. Maintenance
How maintenance will be done.
Who will maintain.
How much time will it take to maintain.
37
Table of Contents for the SDP
(Software Development Plan)
12. Maintenance
Approximately 30 hours per month of
maintenance is expected approximately one year
after turnover. How much maintenance is
expected? The system will need 1 Computer
Manager, 1 User Manager, and 5 computer
programmers assigned. Maintenance
environment will be the same as development.
38
Table of Contents for the SDP
(Software Development Plan)
13. Human Factors
How many users will be impacted by the
new system. How will the educations,
training be accomplished. What culture
changes are expected.
39
Table of Contents for the SDP
(Software Development Plan)
13. Human Factors
There are 3000 users in the group who
will need training from computer literacy to
usage of the system. A culture change
management play will be needed to train the
people in the new method of doing business
and the computer technology to support this
new method.
40
Table of Contents for the SDP
(Software Development Plan)
14. Delivery, Installation and Acceptance
What is considered delivered?
How will we install?
What is considered accepted?
41
Table of Contents for the SDS
(Software Development Specifications)
14. Delivery, Installation and Acceptance
The system will be considered delivered
when each of applications is validated by the
user group. We will roll out installation by each
congressional district. The system will be
considered accepted when 4 districts are
installed and when one billing cycle has been
completed.
42