Page 1 till 45
Reference: [http://www.geocities.com/cs5391/]
LAB 11 (W13:5/Oct/)
Page 59 – 87
Reference: [http://www.geocities.com/cs5391/]
1
Project Log Book
Group Members:
2
a week.
Meeting at Zaida's Place, and decided that this was a point in time where all
November 3rd, changes that need to done should be done to the SPMP this week and our focus
2000 should now be more on the SRS. We completed the discussion about the situation
updates and we moved on to the SRS. We managed to complete until 2.3
Completed compiling the SPMP together, however this document will be checked
November 7th,
by another team member to varify that all changes have been addressed. The SRS
2000
was partly complete since there are problems downloading a picture.
3
Software Requirements Specification
for
Automated Railway Reservation System
Huitang Li
Vahid Keshmiri
Yasin Esmail
Zaida M. Morales
Natasha Dunaeva
Rehan Khan
4
1. Introduction.
1.1 Purpose.
This document describes the software requirements for the Automated Railroad
Reservation System built for the Chinese Railway Ministry (CRM).
1.2 Scope.
The system will be designed to provide an electronic version of the railway passenger
reservation system in China. The system will have a user-friendly graphical interface and
will be more cost effective compared to the current non-electronic version of the
reservation system.
To regain control of the railway ticket sales to avoid scalping and overselling of
tickets.
To implement a prototype of a scaled down version of the final system to test the
solution and further develop requirements.
To collect statistics in a more efficient manner for future railroad development and
construction.
5
CRM – Chinese Railroad Ministry
PP - Project Plan
SDD - Software Design Description
SRS - Software Requirement Specification
SDS – Software Design Specification
SPMP - Software Project Management Plan
GUI – Graphical User Interface
QAM – Quality Assurance Manager
PDM – Project Development Manager
PMP – Project Management Professional
TBD – To be determined
UML – Unified Modeling Language
1.4 References.
1.5 Overview.
Finally, chapter 4 includes all the supporting information, such as the Table of Contents,
the Appendices, and the Index.
6
The Automated Railway Reservation System diagram showing the overview of the
system’s modules and the relationship of the system to external interfaces is presented in
Figure 2.1.
Database:
Stores data
Creates reports
Provides access to data
Updates information
Server:
Provides access to the database
Authenticates users
Processes reservations
Performs backups
Produces reports
External Interfaces:
7
Terminal
Users use terminals to access the server
Passengers and travel agents use terminals to reserve the tickets and to get
information about the available seats on particular trains.
Railroad administration may use terminals to see the reports generated by the
database software.
Personal Computers
Users (passengers, travel agents, and railroad administration) may use personal
computers to obtain a remote access to the server and the reservation database via the
Internet.
Cell Phones
Serve as a medium of accessing the server and the reservation database.
Passengers may use cell phones and the latest telecommunication technologies to
access the server and the reservation database via Internet, or they may use cell
phones to call travel agents to inquire about railroad and ticket information.
Figure 2.2 to 2.6 depict the relationships among the functions to be implemented by the
system.
8
Figure 2.2 ARRS General Function Relationship Diagram
9
Figure 2.4 ARRS Passenger Account Function Relationship Diagram
10
Figure 2.5 ARRS Train Information Function Relationship Diagram
11
12
Figure 2.6 ARRS Display Reports Function Relationship Diagram
Description: This function ensures that only authorized users gain access
to the Reservation databases. An authorized user is a user who has an
account on the system. Users include passengers, train officials, and CRM
ministry officials. The user must type a valid username and password to
gain access.
13
Description: This function allows the user to drop a reservation for a
particular train on a particular date for a certain number of tickets. If the
user does not already have a reservation, then all reservations are dropped.
If the user already has a previous reservation, a chosen reservation is
dropped from the list of current reservations, and the passenger account
balance gets updated.
Description: This function allows the user to see a list of all his/her
current reservations. If the user does not have any reservations at the time
(assuming that the user has a valid account on the Reservation system),
and empty list with a message “No Reservations Have Been Made” is
displayed.
Description: This function allows the user to see a list of all scheduled
train departures including train name, city from and to which the train is
going, the number of seats available, and the prices for different ticket
types.
Description: This function allows the user to add a train with a particular
seat type on a particular date and time to travel between the cities
specified. If the train does not already exist in the train schedule, then a
new train route is created and the ticket availability for that route is
updated. If the train already exists in the train schedule, the train schedule
information is updated.
14
Description: This function allows the user to drop a train of a particular
seat type on a particular date and time that was traveling between the cities
specified. If the train does not exist in the current train schedule, the
request is ignored. If the train exists in the reservation database, the
chosen train is dropped from the list of current train schedules, and the
train schedule gets updated.
The number of trains from city Guangzhou to Shanghai and from Shanghai to
Guangzhou is limited to 5 trains.
The number of passengers that can be taking a train at once is limited to 1080
passengers.
Two of the trains traveling from Guangzhou or Shanghai stop at Nanjing each day
and one of the trains traveling from Guangzhou or Shanghai stops at Nanjing each
day. No trains originate Nanjing.
The functional prototype should be available after 30 days upon the arrival of the
management team to China. This may prove to be a serious time constraint on the
development of a successful prototype.
Communication with the Chinese team members may prove to be difficult since some
Chinese developers do not speak English and the management team does not speak
Chinese. Even with the presence of a translator, communication may be difficult.
Absence of the translator may severely affect project development.
15
Team members are restricted from bringing their own equipment, and insufficient
equipment supply may hinder project development.
Team members are restricted to bringing only the analysts of the team to China. This
might affect the project development if more people are needed or the required skills
are not available.
The majority of the Chinese population does not have or have a limited access to the
Internet.
Scalping of tickets is a popular activity in China, and CRM wants to discourage such
practices.
Ten trains transport the passengers between three cities known as Guangzhou,
Shanghai and Nanjing. These trains originate only in cities Guangzhou and Shanghai,
and they make a stop at Nanjing before arriving to their destination.
Five trains travel from city Guangzhou or Shanghai each day and five travel from city
Guangzhou or Shanghai each day. Two of the trains traveling from Guangzhou or
Shanghai stop at Nanjing each day and one of the trains traveling from Guangzhou or
Shanghai stops at Nanjing each day. No trains originate Nanjing.
Phone reservation involves tickets being purchased within 24 hours after making the
reservation. Otherwise, the reservation will be cancelled.
16
No reservations can be made 48 hours prior to the trip. Rather, it will be done on a
first come first serve basis from that point on.
Number and names of people who show up without reservation for each
departure
The expected reservations during test period may amount to approximately 25,000
per day. This volume varies by hour, day, and season.
Chinese Ministry will provide us with information about identification process used
in China, so that it can be applied to the reservation system and scalping of tickets is
avoided.
CRM trains occasionally may become non-operational. In that case, a new train will
be dispatched, but a delay of up to a few days could occur.
17
26 developers will be provided by the CRM.
The CRM will provide all the required hardware and software resources for the
development of the project.
3. Specific Requirements.
This section of the SRS contains design requirements for the Automated Railway Reservation
System.
Description: This function ensures that only authorized users gain access to the
Reservation databases. An authorized user is a user who has an account on the
18
system. Users include passengers, train officials, and CRM ministry officials.
The user must type a valid username and password to gain access.
Rationale: Logging into the system provides security and confidentiality to the
system. It reduces the chance that someone can taper any individual’s personal
information and prevents unauthorized users from modifying the confidential
information such as reports for CRM or train schedule information.
Specification:
19
3.1.2 Make a Reservation Function
Description: This function allows the user to make a reservation for a particular
train on a particular date for a certain number of tickets. If the user does not
already have a reservation, then a new reservation is created. If the user already
has a previous reservation, a new reservation is added to the list of current
reservations, and the passenger account balance gets updated.
Rationale: A user must have the ability to add a reservation to his/her account.
This function makes this process simple and easy.
Specification:
20
3.1.3 Drop Reservation Function
Description: This function allows the user to drop a reservation for a particular
train on a particular date for a certain number of tickets. If the user does not
already have a reservation, then all reservations are dropped. If the user already
has a previous reservation, a chosen reservation is dropped from the list of current
reservations, and the passenger account balance gets updated.
Specification:
21
Description Remove a reservation from a user’s account
Inputs From city, to city, seat type, travel date,
return date and time
Source User inputs from city, to city, seat type,
travel date, return date and time
Outputs Modified reservation
Destination Computer screen
Reservation database
Passenger Account database
Precondition Reservation must be a part of user’s current
reservations
Post Condition Reservation is removed from user’s
account
Side Effects User’s current reservations adjusted
Balance due adjusted
Ticket availability updated
Description: This function allows the user to see a list of all his/her current
reservations. If the user does not have any reservations at the time (assuming that
22
the user has a valid account on the Reservation system), and empty list with a
message “No Reservations Have Been Made” is displayed.
Specification:
23
Description: This function allows the user to see a list of all scheduled train
departures including train name, city from and to which
the train is going, the number of seats available, and the prices for different ticket types.
Rationale: A list of train departures helps the user to decide what information to
enter to the Make a Reservation and Drop a Reservation functions.
Specification:
24
3.1.6 Display Balance Function
Description: This function provides a listing of the current balance due and
payments received in the past. This information is presented in an easy to follow
format and separately displays each reservation.
Rationale: This function allows the user to keep accurate financial records on
his/her total reservations payed. This information is also useful in figuring out
how much the user has spent in train travel.
Specification:
25
Description Provides a listing of current balance due
and past payments received
Inputs Log In Function
Source Passenger Reservation Database
Outputs Name, address, phone number, date, train
#,
City from, city to, seat type, # of tickets,
subtotal, total
Destination Computer screen
Precondition Successful login to secure network
Post Condition No change to payment information
Side Effects None
Description: This function allows the user to pay his/her current reservation cost.
The user may either pay entire balance due or select to pay in person within 48
hours. The user must also input a valid credit card number or CRM Credit
account number.
26
Rationale: This function allows the user to pay online rather than to pay in
person. To pay online is both more convenient and less time consuming, because
the user is not subject to the hours of operation of the Travel Agent Office.
Specification:
27
3.1.8 Add a Train Function
Description: This function allows the user to add a train with a particular seat
type on a particular date and time to travel between the cities specified. If the
train does not already exist in the train schedule, then a new train route is created
and the ticket availability for that route is updated. If the train already exists in
the train schedule, the train schedule information is updated.
Rationale: A user must have the ability to add a train to the available train
schedule if new trains become available or existing trains are not operational.
This function makes this process simple and easy.
Specification:
28
3.1.9 Drop a Train
Description: This function allows the user to drop a train of a particular seat type
on a particular date and time that was traveling between the cities specified. If the
train does not exist in the current train schedule, the request is ignored. If the
train exists in the reservation database, the chosen train is dropped from the list of
current train schedules, and the train schedule gets updated.
Rationale: A user must be able to remove a train from the train schedule if it is no
longer operational. This function makes this process simple and easy.
Specification:
29
Description Remove a train from the train schedule
Inputs From city, to city, seat type, travel date,
return date, time, and train number
Source User inputs from city, to city, seat type,
travel date, return date, time, and train
number
Outputs Modified train schedule
Destination Computer screen
Reservation database
Passenger Account database
Precondition Train must be a part of current train
schedule
Post Condition Train is removed from train schedule
Side Effects User’s current reservations adjusted
Current train schedule updated
Ticket availability updated
Description: This function allows the user to display the following reports:
30
Number of Reservations for Each Departure Date/Train
Number of Customers Turned Away
Number of No-Shows
Number and Names of People who Showed Up
List of High Buyers
These reports are only available to Chinese Railway Ministry Employees.
Specification:
31
3.2. External Interface Requirements
3.2.1 User Interfaces.
The user interfaces are divided into two major components. One part
includes the user accessing the system using a cell phone. The other portion
involves accessing the system through a remote site or at a particular location
specifically designed to access the system. For instance, the clerks and the CRM
access the reservation system from the reservation or CRM office.
The diagrams and explanations below demonstrate the major transition
from one user interface to another. This is a brief description. However, a more
detailed demonstration is done in the prototype. The purpose of this interaction is
to illustrate the overall view of the ARRS.
The diagram below illustrates the four major functionalities. These
functionalities will be displayed depending on the user. For instance, the CRM
will see all four functionalities while the normal user and the clerks will only see
the Ticket Reservation and the Passenger Account.
32
Selecting one of these functions will take the user to a different user
interface. For instance, choosing Ticket Reservation will display the following
web page. The title of this page is consistent with the function selected, and since
the Ticket Reservation was selected, the title displays Ticket Reservation. The
purpose of this is to allow the user know what part of the system they are
accessing. Furthermore, the user can select any of the four functions.
33
The user can select any of the four functionalities. For the sake of this
demonstration, if the user clicks on the Make Reservation function the diagram
below is displayed. Once again the title is the same as the main function and a
subtitle indicates the second function selected. In addition, the person can fill up
the following information and the date of travel or return if he/she wishes. The
three buttons allow the user to navigate through the interfaces. For instance, the
back button will take the user to the above page, and the clear button will clear the
form of any selection he/she made before. The Display Available displays the
available trains, seats and what city they want to travel to. However, before we get
to the next page when clicking Display Available the picture below illustrates the
Make Reservation function.
34
The Display Available function displays all the trains traveling from one
city to another and the seats available on that train. Furthermore, the last list
displays the number of tickets available for the particular train on the selected
route. The back button will take the user to the above picture, and the confirm
button takes the person to the payment page.
35
The following page allows the user to pay for the ticket as appropriate.
Now, this page is part of the Passenger Account function, and it is used here to
make payment for the ticket selected. This makes it easier for the user since they
do not have to go back to the main menu and to access their account.
Finally, the submit button displays the appreciation page as shown below
with a button to go to the main menu.
36
The above illustration has shown a brief overview of the user interfaces
involved for the normal and clerk users. However, the CRM have specifically
requested a number of reports, and they must be able to adjust their train schedule
as the trains become unavailable. Therefore, the CRM interface is able to access
all four functionalities as shown in the main menu (first diagram). Once the CRM
selects the Reports function, a list of five reports is displayed as linked list. This is
shown in the diagram below:
37
The report selected here shows the number of reservation for each
departure. This report indicates the major traffic flow, and what trains are needed
where during varying time and season. The diagram below shows the report
format to be displayed.
38
As mentioned earlier, the system can also be accessed through the wireless
phones. In that case, the overall system will be the same as the above presentation
except that the format will be simplified, since the phones do not have graphic
support. The phones will have access to the Make Reservation and Passenger
Account, however it is difficult to display the reports and trains information on a
small screen for the CRM.
The aspects of optimizing the interface with the person who must use the system
are briefly described below:
Allow current users to login into the system using a unique user id and
password.
Allow the users to build new itineraries, change and/or view existing
itineraries, and pay for planned itineraries using different methods (credit
cards, CRM credit account).
39
Provide administrative users with access to reports including number of
reservations per train, number of passengers turned away, number of no-
shows, number and names of passengers who showed up, and list of
potential scalpers (high-volume ticket buyers).
40
(3) Version Number: 8
(4) Source: Oracle
41
3.3.2 Application Requirements
Since no specified service is indicated, then we have listed the applications as best
– efforts. This may change as we learn more about the application.
Categorizing Application
Applications Best- Locations
Effort
s
Communication 100 Kb/s Guangzhou and Nanjing
Database Access 400 Kb/s All Locations
Database Transaction processing 1.5 Mb/s All Locations
42
3.4.3 Hardware Limitations.
Input/Output: One or two-button mouse, keyboard, cell-phone, or
touch screen required.
Network card required at thin-client terminals to make communication
with server possible.
3.5.1 Portability
The ARRS system will be developed using HTML and Java so that it can be
accessed from any type of system using just a regular web browser. It will also be
available to users that have web access on their cellular phones. The system will
be tested on all types of hardware before being released to ensure that is it
compliant with this requirement.
3.5.2 Reliability
The system should be capable of processing a given number of reservations
within a give time frame with no errors and the system should be available and
operational all the time. During the development of the prototype for the 3 cities,
the system will be tested in its actual environment to ensure that it can handle the
load of reservations that occur during a regular workday.
3.5.3 Usability
The ARRS system will be developed so that it is an easy to use system that
requires the least amount of user input possible. Every input will be validated.
The user should only have general computer use knowledge. Error messages will
be displayed if the user enters an invalid value or tries to access a function
without the required permissions. An easy and well-structured user manual will
be provided to the CRM and the system will include descriptive help for all
operations allowed.
3.5.4 Correctness
The ARRS system will be considered correct when the CRM approves the
prototype presented and agrees that all the functions they require are implemented
as stated in the Software Requirements Specification.
3.5.5 Flexibility
43
The ARRS system should be developed in such a way that it is easily
customizable. If new functions are required by CRM, there will be little effort
required to update the system to support new cities or new transactions.
3.5.6 Security
The ARRS system should not compromise the customer information at any time.
The user information will never be sold to other parties and will be kept secure at
all times. Users will be authenticated to ensure that no unauthorized users gain
access to private information.
3.5.7 Maintainability
The ARRS source code will be kept well structure and documented so that it is
easier to maintain and extend the system. All changes to the system shall be
documented.
The Automate Railway Reservation System will have two main databases.
One is the Reservation Database, and another is the Passenger Account Database.
These database will be created with Oracle8i (Client/Server) version 8.1.6.0.0
Release 2. The following are the requirements for these databases that are to be
developed as part of the product. They include:
Reservation Database
Schedule information for the trains, including
Types of
date, time, departure city, destination city, ticket
information
cost and ticket availability for a particular train
Depends on the passenger demand, which may
Frequency of use
reach 25,000 per day during peak periods
The database should allow access to at least
1,000 people at once; the users will have a
Accessing general access to the information about the train
capabilities schedule, and a secure access to the reports
(available only to CRM officials) using a
username and a password
Data element and
To be determined
file descriptions
Relationship of To be determined
44
data elements,
records and files
Static and dynamic
To be determined
organization
Train schedule information will be available as
Retention long as the train for a particular route is in use
requirements for and at least one year after the train has been
data cancelled. The reports information will be
available at least for 5 years
3.6.2 Operations.
The normal operations required by the user can be viewed as the following:
User-initiated Operations:
These operations include the login operation, which is initiated by the users. Also,
the process of becoming a new user is in this category. Building, changing, and
viewing itineraries, as well as paying for the itinerary are all initiated by the users.
45
The user initiates the report generation activity, as well as changing train
schedules.
The users initiate all the operations mentioned above, and almost all of them are
somehow interactive. Displaying the train schedule is non-interactive. The report
display is a non-interactive operation, although selecting the desired reports will
require user input.
The user account data is used to create new accounts, as well as to validate user
id's during login functions. For building itineraries, user input, user account data,
and train schedule data are used, and processed. User data along with final results
of user interaction (whether the user purchased a trip, number of tickets bought,
etc.) are collected, and used for report generation purposes. Administrative users'
inputs are collected in order to modify and present schedules.
Both databases used (passenger account database and reservations database) are
production databases. The main operation used for the backup and recovery is
Oracle's built-in cold backup, which is also known as the "archive mode".
Depending on the customer's needs and budget, additional redundancy can be
added using systems like RAID 5 and tape backup.
4. Supporting Information.
There is no supporting information required for this project.
46
Software Requirements Specification
for
Automated Railway Reservation System
Huitang Li
Vahid Keshmiri
Yasin Esmail
Zaida M. Morales
Natasha Dunaeva
Rehan Khan
November 7, 2000
1. Introduction.
This document describes the software requirements for the Automated Railroad
Reservation System built for the Chinese Railway Ministry (CRM).
47
The CRM is requesting proposals to build a prototype of an Automated Railroad
Reservation System (ARRS) for their current system. This new ARRS needs to be
scalable enough so that it can accommodate the increase in reservations caused by new
railroad building in China.
The system will be designed to provide an electronic version of the railway passenger
reservation system in China. The system will have a user-friendly graphical interface and
will be more cost effective compared to the current non-electronic version of the
reservation system.
To regain control of the railway ticket sales to avoid scalping and overselling of
tickets.
To implement a prototype of a scaled down version of the final system to test the
solution and further develop requirements.
To collect statistics in a more efficient manner for future railroad development and
construction.
48
TBD – To be determined
UML – Unified Modeling Language
1.4 References.
1.5 Overview.
Finally, chapter 4 includes all the supporting information, such as the Table of Contents,
the Appendices, and the Index.
49
Figure 2.1 Overview Diagram of the ARRS
Database:
Stores data
Creates reports
Provides access to data
Updates information
Server:
Provides access to the database
Authenticates users
Processes reservations
Performs backups
Produces reports
External Interfaces:
Terminal
Users use terminals to access the server
Passengers and travel agents use terminals to reserve the tickets and to get
information about the available seats on particular trains.
50
Railroad administration may use terminals to see the reports generated by the
database software.
Personal Computers
Users (passengers, travel agents, and railroad administration) may use personal
computers to obtain a remote access to the server and the reservation database via the
Internet.
Cell Phones
Server as a medium of accessing the server and the reservation database.
Passengers may use cell phones and the latest telecommunication technologies to
access the server and the reservation database via Internet, or they may use cell
phones to call travel agents to inquire about railroad and ticket information.
51
The number of passengers that can be taking a train at once is limited to 1080
passengers.
Two of the trains traveling from Guangzhou or Shanghai stop at Nanjing each day
and one of the trains traveling from Guangzhou or Shanghai stops at Nanjing each
day. No trains originate Nanjing.
The functional prototype should be available after 30 days upon the arrival of the
management team to China. This may prove to be a serious time constraint on the
development of a successful prototype.
Communication with the Chinese team members may prove to be difficult since
some Chinese developers do not speak English and the management team does not
speak Chinese. Even with the presence of a translator, communication may be
difficult. Absence of the translator may severely affect project development.
Team members are restricted from bringing their own equipment, and insufficient
equipment supply may hinder project development.
Team members are restricted to bringing only the analysts of the team to China.
This might affect the project development if more people are needed or the required
skills are not available.
The majority of the Chinese population does not have or have a limited access to
the Internet.
52
The trains will be assumed to be of a constant size that accommodates 1080
passengers at a time. They will consist of:
2 soft-sleeping coaches (12 compartments each)
2 hard-sleeping coaches (12 compartments)
2 soft-seating coaches (60 seats)
9 hard-sitting coaches (80 seats each)
The following management reports will be available:
Number of reservations made for each departure date/train
Number of customers turned away because of full trains for each
departure/train
Number of no-shows for each departure
Number and names of people who show up without reservation for each
departure
List of high buyers of train tickets.
The expected reservations during test period may amount to approximately 25,000
per day. This volume varies by hour, day, and season.
Chinese Ministry will provide us with information about identification process
used in China, so that it can be applied to the reservation system and scalping of
tickets is avoided.
Network connection will always remain established.
The CRM will provide all the required hardware and software resources for the
development of the project.
A facilitator from CRM to help make arrangements with government authorities,
make travel arrangements, and serve as a host to our country.
The telecommunications channels available in China are sufficient for the
development of a feasible client server system.
Three analysts in the Bangalore software development center.
53
Australian design center manager
Two documentation specialists from company.
Three field applications mangers from the Taiwan office.
3. Specific Requirements.
This section of the SRS should contain all the details the software developer needs to create a
design. This is
typically the largest and most important part of the SRS.
(1) The details within it should be defined as individual specific requirements, following the
guidelines for sound
requirements (verifiable, unambiguous, etc.)
(2) Specific requirements should be organized in a logical and readable fashion.
(3) Each requirement should be stated such that its achievement can be objectively verified by
a prescribed
method.
(4) Sources of a requirement should be identified where that is useful in understanding the
requirement.
(5) One way to classify the specific requirements is as follows:
(a) Functional Requirements
(b) Performance Requirements
(c) Design Constraints
(d) Attributes
(e) External Interface Requirements
The best organization for this section depends on the application area and the nature of the
software product being
specified. Tables 1 through 4 at the end of this template show four possible organizations.
(1) In Table 1, all the Functional Requirements are specified, then the four types of interface
requirements are
specified, and then the rest of the requirements are specified.
(2) Table 2 shows the four classes of interface requirements applied to each individual
Functional Requirement.
This is followed by the specification of the rest of the requirements.
(3) In Table 3, all of the issues addressed by the Functional Requirements are specified, then
the other
requirements that apply to them are specified. This pattern is then repeated for each of the
External Interface
Requirement Classifications.
(4) In Table 4, the interface requirements and the rest of the requirements are specified as they
pertain to each
Functional Requirement.
The organization of this section of the SRS should be chosen with the goal of properly specifying
the requirements in
the most readable manner. The template outline that follows uses an organization like Table 1.
54
3.1 Functional Requirements.
This subsection of the SRS should specify what is to be done by the product, to what
level or specific requirement,
what inputs should be transformed to what outputs (not how this is done), what specific
operations are required.
Where the rationale for a requirement is not obvious, provide an explanation. Where
issues need to be resolved, cite
those.
For each function, specify requirements on inputs, processing, and outputs. These are
usually organized with these
four subparagraphs:
(1) Purpose of the function: Provide rationale to clarify the intent of the function.
(2) Inputs: sources, valid ranges of values, any timing concerns, operator
requirements, special interfaces
(3) Operations to be performed: validity checks, responses to abnormal conditions,
types of processing required
(4) Outputs: destinations, valid ranges of values, timing concerns, handling of illegal
values, error messages,
interfaces required
For example, the following might be an example specification. Depending on the level of
tracking required by the
project, one might trace each of the components of 3.1.1 as separate requirements, or one
might trace just 3.1.1. Note
that the level of detail here tells what needs to be accomplished against what specific
goals, but it does not specify
how that is to be done.
3.1. Provider Terminal (PT) Functional Requirements
3.1.1. Signature Verification
Purpose: The PT shall have a signature recognition system that can be used to
authenticate users of the ChocAn
membership services.
Inputs: Members sign their name once when applying for membership. Each
authentication effort done when a
service is requested should take no more than one signature by the member.
Processing: Handling of the authorization should take no more than 5 seconds.
Outputs: If the match is successful, a positive acknowledgment must come to the
member at the signature capture
device as well as to the PT. If the match is unsuccessful, an appropriate message to
that effect must be
provided to both the capture device and the PT.
55
This should specify:
(1) The characteristics that the software must support for each human interface
to the software product. For
example, if the user of the system operates through a display terminal, the
following should be specified:
(a) Required screen formats
(b) Page layout and content of any reports or menus
(c) Relative timing of inputs and outputs
(d) Availability of some form of programmable function keys.
(2) All the aspects of optimizing the interface with the person who must use the
system. This may simply
comprise a list of do's and don'ts on how the system will appear to the user.
56
(1) Static numerical requirements may include:
(a) The number of terminals to be supported
(b) The number of simultaneous users to be supported
(c) Number of files and records to be handled
(d) Sizes of tables and files
Static numerical requirements are sometimes identified under a separate section entitled
capacity.
(2) Dynamic numerical requirements may include, for example, the numbers of
transactions and tasks and the
amount of data to be processed within certain time periods for both normal and peak
workload conditions.
All of these requirements should be stated in measurable terms, for example, 95% of the
transactions shall be
processed in less than 1 s, rather than, operator shall not have to wait for the transaction
to complete.
Note: Numerical limits applied to one specific function are normally specified as part of
the processing
subparagraph description of that function.
57
• Correctness - extent to which program satisfies specifications, fulfills user’s mission
objectives
• Efficiency - amount of computing resources and code required to perform function
• Flexibility - effort needed to modify operational program
• Integrity/security - extent to which access to software or data by unauthorized people
can be controlled
• Interoperability - effort needed to couple one system with another
• Maintainability - effort required to locate and fix an error during operation
• Portability - effort needed to transfer from one h/w or s/w environment to another
• Reliability - extent to which program performs with required precision
• Reusability - extent to which it can be reused in another application
• Testability - effort needed to test to ensure performs as intended
• Usability - effort required to learn, operate, prepare input, interpret output
3.5.1 xxx
Describe the rationale for including this characteristic for this product.
3.5.2 yyy.
etc.
This could specify the requirements for any data base that is to be developed as
part of the product. This might
include:
(1) Types of information
(2) Frequency of use
(3) Accessing capabilities
(4) Data element and file descriptions
(5) Relationship of data elements, records and files
(6) Static and dynamic organization
(7) Retention requirements for data
58
3.6.2 Operations.
This could specify the normal and special operations required by the user such as:
(1) The various modes of operations in the user organization; for example, user-
initiated operations
(2) Periods of interactive operations and periods of unattended operations
(3) Data processing support functions
(4) Backup and recovery operations
This could:
(1) Define the requirements for any data or initialization sequences that are
specific to a given site, mission, or
operational mode, for example, safety limits.
(2) Specify features that should be modified to adapt the software to an
installation.
4. Supporting Information.
The supporting information; that is, the Table of Contents, the Appendices, and the Index, make
the SRS easier to use.
The Appendices are not always considered part of the actual requirements specification and are
not always
necessary. They might include:
(a) Sample I/O formats, descriptions of cost analysis studies, results of user surveys.
(b) Supporting or background information that can help the readers of the SRS.
(c) A description of the problems to be solved by the software.
(d) The history, background, experience and operational characteristics of the organization
to be supported.
(e) A cross-reference list, arranged by milestone, of those incomplete software requirements
that are to be
completed by specified milestones.
(f) Special packaging instructions for the code and the media to meet security, export,
initial loading, or other
requirements.
(3) When Appendices are included, the SRS should explicitly state whether or not the
Appendices are to be
considered part of the requirements.
59
Software Project Management Plan
Automated Railway Reservation System
Huitang Li
Vahid Keshmiri
Yasin Esmail
Zaida M. Morales
Natasha Dunaeva
Rehan Khan
60
Update
Table of Contents
1. Introduction.
1.1 Project Overview.
1.2 Project Deliverables.
61
1. Introduction.
The Chinese railroad system currently consists of 65,000 km of rails and plans are being
developed to increase it to 70,000 km by the year 2002. It is estimated that
approximately 3.7 million Chinese and foreign visitors use the country’s railway system.
Furthermore, the railroad use is expected to increase as the population grows and new
railways are added. Therefore, the CRM have expressed great concern about automizing
their reservation system.
Currently, the train tickets can usually be purchased at the China International Travel
Service (CITS) desk in major tourist hotels, through advance booking offices or foreign
desks at the train stations. In order to keep up with the increasing use of the railroad
system in China, the existing reservation systems needs to be refined. Thus the Chinese
Railway Ministry (CRM) requests proposals to build a prototype of an Automated
Railroad Reservation System (ARRS) based on their current railway system.
The new ARRS needs to be scalable enough so that it can accommodate the increase in
reservations caused by new railroad building in China. The proposal must express this
ideology in the project plan (PP) and implement a prototype to illustrate this
functionality. The PP and the prototype to be presented will be evaluated on the
feasibility of the development plan and process description. However, the management
approach and appropriateness to the project at hand will play an important part in the
selection of the proposal. If the prototype proves to be a feasible alternative to the
needed ARRS, our team will be given the opportunity to manage the overall development
of the actual ARRS that will be implemented throughout reservation offices in China. In
the case that our plan is approved by the CRM, the PP will be updated as the project
progresses.
62
The objectives of the development effort are as follows:
To provide existing clerks with a new environment in which to make
reservations for railroad travel.
To provide an avenue for customers to obtain their tickets in a more
convenient way.
To regain control of the railway ticket sales in order to avoid scalping
and overselling of tickets.
To implement a prototype of a scaled down version of the final system
to test the solution and further refine the requirements.
To collect statistics in a more efficient manner for future railroad
development and construction.
To increase efficiency of reservations.
Furthermore, the project is divided into major work tasks that enables to
determine the phase of the project plan. The list below indicates the work
activities:
Problem specification
Risk Analysis
Design stage
Implementation
Testing and evaluation
Quality Assurance
Maintenance
Project resources fall into two categories: people and equipment. People
working for the ARRS include 26 professional software developers of
Chinese nationality, who shall be provided by the CRM, and other 6
members from our management team. Furthermore, the CRM will also
provide the necessary hardware and software for implementing the project.
The ARRS system structure to be developed will include a central
database to keep all reservation information, and several web servers to
process all reservation transactions. Travelers will be able to obtain their
tickets online through a web browser, by calling a reservation desk or a
travel agency. There are no budget constraints for the project at this time.
63
1.2 Project Deliverables.
The different parts of the project will be divided among the team
members, who will submit their work in a group Yahoo web account. The
individual parts of the project will be checked and put together by the
project manager. All changes will be reflected on the table at the beginning
of this document and each version and change date will be noted. A team
member will regularly review all documents. Weekly updates shall be
communicated to the project manager who will immediately address these
changes. After comments and issues are resolved, the document will be
approved and a new version will be made available.
64
Introduction – Chinese Railway Passenger Reservation System
Prototype
http://www.cs.swt.edu/~donshafer/project_documents/5391_Case.html
Situation Update – Chinese Railway Passenger Reservation System
http://www.cs.swt.edu/~donshafer/Marketing%20Update(1).htm
China 2000
http://www.china2thou.com/
Pressman, Roger S., Software Engineering: A Practitioner’s
Approach, McGraw-Hill Companies, Inc., 1997.
2. Project Organization.
This section refers to the process model for the project and its organizational
structure.
The ARRS project requires frequent customer and user interaction. For that
reason, our first choice included the Prototype model. However, we had doubts
about the prototype model, and therefore we concluded to use the Spiral Model.
The risk-based approach of the Spiral Model is significant to the development of
this prototype, and it would also help select an established lifecycle model or
65
determine a different model constructed from various phases of other lifecycle
models. After regular reviews using the risk analysis table stated in the appendix,
we decided that the best approach was to use a hybrid model that would
implement the risk management of the spiral model along with the incremental
model, which is a mixture of the prototype model and the linear sequential model.
Currently, the project revolves around two established stages: Requirement
Analysis and Prototype Development. Figure 1 shows the life cycle for the
development process as well as entry and exit criteria for the different phases of
the project.
The internal management of the project, as well as how the project relates
to the rest of the organization is included in Figure 2.
66
2.3 Organizational Interfaces.
67
Change Control: Team 2 Don Shafer cs5391@yahoo.com
Project Leader Leads project team; responsible for project Yasin Esmail
deliverables
Project Management Assisting in building SPMP, SRS and prototype, as Zaida M. Morales
Team/Analysts well as doing the necessary requirement and risk Vahid Keshmiri
analysis for the project
Huitang Li
Natasha Dunaeva
Rehan Khan
Project Leads Chinese software developers; responsible for TBD
Development project deliverables
Manager
68
process and reports the results of the testing process
to the software manager
3. Managerial Process.
69
Project Dimension Fixed Constrained Flexible
Cost
X
Schedule
X
Scope (functionality)
X
The ARRS project will be tested among three major cities before being
implemented on a larger scale. Therefore, the foundation of the prototype
must be based on several assumptions and restrictions.
Five trains travel from Guangzhou to Shanghai each day and five
other trains travel from Shanghai to Guangzhou each day. Two of
the trains traveling from Guangzhou to Shanghai stop at Nanjing
each day, and one of the trains traveling from Shanghai to
Guangzhou stops at Nanjing each day. No trains originate
Nanjing.
70
Seats are assigned during reservation.
71
Scalping of tickets is a popular activity in China, and CRM wants
to discourage such practices.
26 developers will be provided by the CRM as follows:
1 project manager who speaks English very well.
72
The functional prototype should be available after 30 days upon
the arrival of the management team to China. This may prove to
be a serious time constraint on the development of a successful
prototype.
Size of the software being Reviewing constant feedbacks Being flexible in the software
very large and larger from the customers in project design to accommodate the
number of users than meetings necessary changes
planned
The software not being Response from the CRM, Early and intensive interaction
accepted by the CRM reviewed on every project with the customer for the success
meeting of project.
Cost factor involved in this Reviewing reports on Have additional funding allocated
project expenditure and other cost for it in advance and using it in
related tp the estimated cost in case of emergencies.
the SPMP
Customer requirements CRM participation in design A new prototype will replace the
amy change process and reviewing feedback previous one to accommodate the
information in group meetings change
Technology will not meet Constantly reviewing project Exploring alternatives for the
73
expectation progress reports by Project outdated technologies
Development Manager and
software managers
Lack of training on tools Reviewing progress report by Providing adequate training that is
and staff being software managers to determine necessary for the completion of the
inexperienced the status of the project project
The prototype not being Constant reviews among team Setting deadline before the actual
delivered on time members to ensure continuous time for submission of the project
progress on the prototype
Reporting
Management
74
Figure 3: Basic Management Structure
The Quality Assurance team must, in the first place, ensure the
quality of the software process. So, the Quality Assurance team:
Defines process standards such as how reviews should be
conducted, and when reviews should be held;
Monitors the development process to ensure that the standards are
being followed; and
Reports the software process to software manager and project
development manager.
Responsibilities
Table 6 shows the reporting and communication plan for the project. This
may change as the project progresses.
75
Time Period
Information From To
Communicated
We intend to use the people recommended by the CRM for various tasks.
At the moment, we don’t foresee a need for any extra staffing on the
project. The staffing approach for this project is as follows:
76
Manager and the Project Management Team. The Project
Development Manager decides who gets to be manager of which team.
The Software Manager of team 1, team 2, and team 3 and the
Programming Manager will decide who will become Development
Engineer, Test Engineer, Code Developer, and Test Technician. In the
end, the Project Development Manager approves the decision.
The Project Development Manager and the Project Management Team
staff the Quality Assurance Manager and the Quality Engineer
positions.
Vahid and Huitang will receive UML and CASE training in the next
two weeks in USA and apply this new knowledge on this project to
improve work efficiency and effectiveness. They will not go to China.
However, parts of their jobs will serve as home knowledge base for
client training and project plan advising.
The Project Manager gets to decide or redistribute the work force
among teams in the case that any member of the team gets sick.
Nevertheless, he needs to inform the Project Development Manager
about it.
4. Technical Process.
This section specifies the technical methods, tools, and techniques to be used on the
project. It also includes identification of the work products and reviews to be held and
the plans for the support group activities in user documentation, training, software
quality assurance, and configuration management.
The CASE tool and its object oriented development methodology with
unified modeling language representation (UML) and instant Java code
generation is used in this software development project. The manager with
Project Management Professional (PMP) knowledge works closely with
international marketing groups to use all the varied hardware and software
capabilities within the corporation to win new international business.
77
The work falls into separate categories, where each category involves one
or more people working on it. A reference to initial computing design
structure is shown in Section 4.2.2 Software Design Description (SDD) to
illustrate the functionalities of the work products. The initial design
requires four work products. However, this is a target of constant change
after every review. The work products are divided according to their
different contributions to the whole project. For instance, data storage and
warehousing is a different module from the server, since both have
different functionalities. One holds data, while the other controls traffic
flow and access to the database.
Table 7 displays the work products and the types of reviews held for each
one.
Server
Design Review
Implementation
78
of the project design. More information will be provided
during the High Level Design and Detailed Design phases.
79
against the SRS. Each risk in the SRS must be confronted
and shown to be resolved in the SDD. Redesign or
alteration of the SDD will be implemented if unsatisfied
requirements are confronted during SDD validation and
verification tests or reviews.
80
In this section, the work packages, dependency relationships, resource requirements,
allocation of budget and resources to work packages, and a project schedule are
specified
Table 8 shows the work packages for the activities and tasks that must be
completed in order to satisfy the project agreement. Each work package is
uniquely identified.
81
Detail Level
Design
Detail Level
Review
Prototype 3
System Source Code &
Construction Executable
Program
Review by CRM
System Testing
Verification Summary Report
& Validation Review by CRM
Customer
Acceptance
Feedback
System System Delivery
Delivery & Maintenance
5.2 Dependencies.
82
83
5.3 Resource Requirements.
The resource requirements are divided into four separate categories, and
these may be needed at different times during the lifecycle of the project.
The division of resources falls into hardware and software requirements,
travel, computer time and number and types of personnel.
At the initial stages of the project, we need offices, phones, fax machines
and other editorial and visual programs on each workstation. This phase of
the project involves the six members of team 2 refining and polishing the
SRS and SDS. The time frame varies from six months to one year for a
satisfactory completion of these phases since they are a vital part of the
project implementation.
These are the basic computer resources required. The coding period
involves the use of all hardware and software, as well as 30 persons
working on the project. Therefore, all resources are used at this point in
time.
84
the mobile phones have excellent reception in China, and several Chinese
own these mobile units. Furthermore, the technology to have access to the
internet is possible through specially designed mobile phones that support
WAP structure. Therefore, we decided to use the semi-conductor
fabrication plant in Taiwan to design the components that provide the
support for internet access. Additionally, the cellular phone assembly plant
in Guangzhou can assemble these components to be sold to the Chinese.
Finally, the application design such as WML (language interpreted by the
WAP technology) shall be implemented by us so that the Chinese have the
ability to access the ARRS using their mobile units.
85
Development Engineer
Manager
Personnel 1 Chinese 4 Chinese 6 Chinese 9 Chinese 6 Chinese
person (with analysts/ analysts/ analysts/ analysts/
English programmers programmers programmers programmers
skills) and 4
members of
team 2
Hardware Two 4 6 9 9
workstations, workstations, workstations, workstations, workstations,
one per one per person one per one per one per
person, and person person person
one box for
database
warehouse
Other
Required software for the project includes: Oracle DBMS, Linux Operating
System, Apache Web Server, Sun Java Virtual Machine 1.2, Sun Java
Development Kit 1.2, C/C++ Compiles, Internet Explorer or Netscape Navigator,
and some version control software, such as CVS or CMVC, wireless equipement.
Budget
Some of the basic items required for the development process, and their prices are
listed in Table 10.
86
Total $53,616
6. Additional Components.
This section contains any additional components required for clarification of the
different part of the SPMP.
6.1 Index.
An index to the key terms and acronyms used throughout the SPMP will
be provided in the future.
6.2 Appendices.
87
C. Current Detailed Project Schedule
D. General Information
88
Software Project Management Plan
Automated Railway Reservation System
Huitang Li
Vahid Keshmiri
Yasin Esmail
Zaida M. Morales
Table of Contents
1. Introduction.
1.1 Project Overview.
1.2 Project Deliverables.
89
1.4 Reference Materials.
1.5 Definitions and Acronyms.
2. Project Organization.
2.1 Process Model.
2.2 Organizational Structure.
2.3 Organizational Interfaces.
2.4 Project Responsibilities.
3. Managerial Process.
3.1 Management Objectives and Priorities.
3.2 Assumptions, Dependencies, and Constraints.
3.3 Risk Management.
3.4 Monitoring and Controlling Mechanisms.
3.5 Staffing Approach.
4. Technical Process.
4.1 Methods, Tools, and Techniques.
4.2 Software Documentation.
4.2.1. Software Requirements Specification (SRS).
4.2.2. Software Design Description (SDD).
4.2.3. Software Test Plan.
4.2.4. User Documentation.
4.3 Project Support Functions.
5. Work Packages, Schedule, and Budget.
5.1 Work Packages.
5.2 Dependencies.
5.3 Resource Requirements.
5.4 Budget and Resource Allocation.
5.5 Schedule.
6. Additional Components.
6.1 Index.
6.2 Appendices.
90
1. 1. Introduction.
Parts of the project will be divided among the four group members, who will
submit their work in a group Yahoo web account. The individual parts of the
project will be checked and put together by the project manager. The changes will
be reflected on the table at the beginning of this document and each version and
change date will be noted.
More information about the project can be found in the following documents:
91
1.5 Definitions and Acronyms.
The ARRS requires frequent user interaction, thus it would be best to use the
Prototype model since it incorporates all or most software qualities in the final
product. Currently, the process model includes the following stages, although this
may change in the future:
Requirement analysis
Prototype
Design
Coding
Testing
Release
Maintenance
92
Figure 1: Baseline Life Cycle
93
Figure 2: Organization Chart
Development CRM
Project Leaders
Developers/ testers
3. 3. Managerial Process.
94
3.1 Management Objectives and Priorities.
Cost X
Schedule X
Scope (functionality) X
The project objectives include building a prototype, and the priorities involves the
prototype meets the user specification and is has a feasible development plan
under fixed schedule. The assumption are the operation of ten trains travelling
between two cities. The prototype must be made around these assumptions and
constraints however, the product may accommodate on a larger scale
At the moment, the risks involved are not more than two. The first risk is of
higher priority than the latter one since it involves the completion of the prototype
on time. The other risk involves the prototyping being rejected by the CRM. This
puts a lot strain on our time and money.
Define the reporting mechanisms, report formats, review and audit mechanisms,
and other tools and techniques to be used in monitoring and controlling adherence
to the SPMP. Project monitoring should occur at the level of work packages.
Include monitoring and controlling mechanisms for the project support functions
(quality assurance, configuration management, documentation and training).
A table may be used to show the reporting and communication plan for the
project. The communication table can show the regular reports and
communication expected of the project, such as weekly status reports, regular
reviews, or as-needed communication. The exact types of communication vary
between groups, but it is useful to identify the planned means at the start of the
project.
95
Table 4. Communication and Reporting Plan.
We intend to use the people recommended by the CRM for various tasks. At the
moment we have categorized the list of required skills as follows:
4. 4. Technical Process.
This section specifies the technical methods, tools, and techniques to be used on the project.
It also includes identification of the work products and reviews to be held and the plans for
the support group activities in user documentation, training, software quality assurance, and
configuration management.
Specify the work products to be built for this project and the types of peer reviews
to be held for those products. It may be useful to include a table that is adapted
from the organization’s standard collection of work products and reviews. Identify
any relevant style guide, naming conventions and documentation formats. In
96
either this documentation plan or the project schedule provide a summary of the
schedule and resource requirements for the documentation effort.
To ensure that the implementation of the software satisfies the requirements, the
following documentation is required as a minimum:
The SRS clearly and precisely describes each of the essential requirements
(functions, performances, design constraints, and attributes) of the
software and the external interfaces. Each requirement is defined such that
its achievement is capable of being objectively verified and validated by a
prescribed method, for example, inspection, analysis, demonstration, or
test.
The Software Test Plan describes the methods to be used for testing at all
levels of development and integration: requirements as expressed in the
SRS, designs as expressed in the SDD, code as expressed in the
implemented product. The test plan also describes the test procedures, test
cases, and test results that are created during testing activities.
Provide either directly or by reference, plans for the supporting functions for the
software project. These functions may include, but are not limited to,
configuration management, software quality assurance, and verification and
validation. Plans for project support functions are developed to a level of detail
consistent with the other sections of the SPMP. In particular, the responsibilities,
resource requirements, schedules and budgets for each supporting function must
be specified. The nature and type of support functions required will vary from
project to project, however, the absence of a software quality assurance,
97
configuration management, or, verification and validation plan must be explicitly
justified in project plans that do not include them.
Specify the work packages for the activities and tasks that must be completed in
order to satisfy the project agreement. Each work package is uniquely identified.
A diagram depicting the breakdown of project activities and tasks (a work
breakdown structure) may be used to depict hierarchical relationships among
work packages.
5.2 Dependencies.
Specify the allocation of budget and resources to the various project functions,
activities, and tasks.
5.5 Schedule.
Provide the schedule for the various project functions, activities, and tasks, taking
into account the precedence relations and the required milestone dates. Schedules
may be expressed in absolute calendar time or in increments relative to a key
project milestone.
98
6. 6. Additional Components.
Certain additional components may be required and may be appended as additional sections
or subsections to the SPMP. Additional items of importance on any particular project may
include subcontractor management plans, security plans, independent verification and
validation plans, training plans, hardware procurement plans, facilities plans, installation
plans, data conversion plans, system transition plans, or the product maintenance plan.
6.1 Index.
An index to the key terms and acronyms used throughout the SPMP is optional,
but recommended to improve usability of the SPMP.
6.2 Appendices.
99
100