Documente Academic
Documente Profesional
Documente Cultură
Software Requirements
Specification
Version 1.1
November 2013
This document provides guidance for the formatting and organization of Software
Requirements Specifications (SRS) to students of the Vietnamese-German University of Vietnam,
who are taking the class English for Computer Science. The software requirement statement
students are expected to prepare for this course is based on the industry standard Software
Requirements Specification and is intended to provide students with an introduction to the
fundamentals of technical writing for Computer Science engineers.
This guide should not be considered as a rigid requirement, but more as a set of suggestions
on how students can organize their Software Requirements Specifications. The examples presented
in this guide are neither to be considered as complete nor as absolutely required, but are provided to
give an idea of the kind of information that would appear in the different sections. Students will
need to provide more details in many of the sections, additional sections may need to be added and
some sections may be eliminated, depending on the particular requirements of the system being
proposed.
While every effort has been made to insure the accuracy of this document, if you notice any
errors, please bring them to the attention of the Course Instructor.
Richard G. Bradley, MAL, MSM
Course Instructor
Change Log
Date
Change
Reason
29
Nov
2013
(Note to students: Don't include this page in your report either. The cover sheet labels on the next
page should be your first page)
(cover sheet)
(Label should be about 1/3 down the page)
Robocreams menu
Version 1.0
(Letter of Transmittal)
(Begin 1 line 2.m from top of paper or after 1 blank line after Letterhead)
st
<student name>
<student number>
Class <class number>
<date>
(1 blank line)
<Instructor>.
Vietnamese German University
Foundation Year Studies
Nam K Khi Ngha Street, Ha Ph District
Bnh Dng New City, Bnh Dng Province
(1 blank line)
Dear Mr.Richard Bradley, MAL, MSM
(1 blank line)
Enclosed is our Software Requirements Specification for our class project entitled <proposal
name> submitted to partially meet the requirements for The CS2015 class.
This Software Requirements Specification discusses the context for the project, gives an overview
of what is to be produced, provides justification for the development of the software, addresses the
feasibility of the project and include a development schedule in the form of a Gantt chart.
I appreciate the time you are taking to review this Software Requirements Specification and hope
that it meets your and the boards approval so that we may go ahead and build and evaluate the
prototype. If you have any more questions feel free to contact me either by telephone <telephone
number> or e-mail: <email address>.
(1 blank line)
Sincerely yours,
(3 blank lines)
<Student Name>
Team Leader
(1 blank line)
Enclosure:<name of proposal>(1 Copy)
(title page)
Robocreams menu
Version 1.0
(24 pt Times New Roman, bold)
L Hong Qun
Phan Gia Thnh
Phm Th Thanh Tho
(16 pt Times New Roman)
(disclaimer)
Disclaimer
(18pt Times New Roman, bold)
(This is a boilerplate requirement. Type it exactly as it is written below and sign it.)
(12 pt Times New Roman)
We declare that this Software Requirements Specification is a product of our own work,
unless otherwise referenced. We also declare that all opinions, results, conclusions and
recommendations are our own and may not represent the policies or opinions of the
Vietnamese-German University.
<Student Name>
<Student Name>
<Student Name>
Abstract
(Heading 1, 18 pt Times New Roman, bold)
The purpose of the Robocreams menu, Version 1.0 project is to create a working
online menu for an ice-cream/cafe store named Robocream. The project is expected to replace the
traditional paper menu that has become obsolete and inconvenient according to todays standard.
(Briefly describe the proposed system.)
Robocreams menu, Version 1.0 will consist of a web-based client interface. The
websites users will have access to all of the websites contents which includes Robocreams
history, products, prices, events, the design teams information and e-mail. However, in order to
change those information, the user must have the admins privilege. The user can gain access to this
privilege by logging in the admin page with an account that is circulated internally. The web pages
have been created using HTML 3.2 and use Javascript for some functions. Client requirements are
minimal, any modern browser will be sufficient and the website can be hosted on a server can with
512MB of memory and a 2592 MHz Intel Model 2 CPU or better.
Key words: topic, client, server, SQL, VGU, circulated internally
ii
Acknowledgements
(Acknowledge anyone who assisted you)
We would like to express my deep appreciation to the lecturers of the Vietnamese-German
University for their explanations and guidance
We would also like to thank all my friends and classmates for their suggestions and assistance
during the writing of this Software Requirements Specification.
During the creation of this report:
Le Hoang Quan was responsible for writing reports, drawing the development plan and
offering some minor assistance in the coding process.
Pham Thi Thanh Thao was responsible for preparing presentations, drawing the websites
sketch, coding the menu pages, the admin function and designing the look of the website.
Phan Gia Thinh was responsible for designing and coding the index page (homepage),
providing some useful softwares for the design process.
Le Hoang Quan
iii
Table of Contents
Disclaimer.............................................................................................................................................1
Abstract.................................................................................................................................................2
Acknowledgements..............................................................................................................................4
Table of Contents..................................................................................................................................5
List of Figures.......................................................................................................................................7
List of Tables........................................................................................................................................7
1.Introduction.......................................................................................................................................1
1.1.Purpose (heading 2, 14 pt,Times New Roman, bold)................................................................1
1.2.Audience....................................................................................................................................1
1.3.Project Scope.............................................................................................................................1
1.4.Overview of the Document........................................................................................................2
2.Context of the Project........................................................................................................................3
2.1.Background................................................................................................................................3
2.2.Current System...........................................................................................................................3
3.Overview of the Proposed System....................................................................................................5
3.1.Description.................................................................................................................................5
3.2.Product Features ........................................................................................................................5
3.2.1.Login (heading3, Times New Roman, bold).......................................................................5
3.2.2.Administrators Menu..........................................................................................................5
3.2.2.1.Create new users...............................................................................................................6
3.2.2.2.Delete users......................................................................................................................6
3.2.2.3.Modify user information...................................................................................................6
3.2.2.4.List topics by submitted date, Student ID or Student name.............................................6
3.2.2.5.Review submissions and Approve/Disapprove topics......................................................6
3.2.3.Users Menu.........................................................................................................................6
3.2.3.1.Terms and Conditions.......................................................................................................7
3.2.3.2.Modify Personal Data.......................................................................................................7
3.2.3.3.List topics by submitted date, Student ID or Student name.............................................7
3.2.3.4.Submit a topic for approval..............................................................................................7
3.3.User Classes...............................................................................................................................7
3.3.1.Instructor..............................................................................................................................7
3.3.2.Users....................................................................................................................................7
3.4.Operating Environment..............................................................................................................8
3.4.1.Hardware Platform..............................................................................................................8
3.5.Design and Implementation Constraints....................................................................................8
3.5.1.Software Constraints...........................................................................................................8
3.5.2.Database Constraints...........................................................................................................8
3.6.User Documentation..................................................................................................................9
3.6.1.Administrator Manual.........................................................................................................9
3.6.2.User Manual........................................................................................................................9
3.6.3.On-Line Help.......................................................................................................................9
3.7.Assumptions and Dependencies................................................................................................9
3.7.1.Assumptions........................................................................................................................9
3.7.2.Dependencies.....................................................................................................................10
4.External Interface Requirements.....................................................................................................11
4.1.User Interfaces.........................................................................................................................11
4.1.1.HTML Standard.................................................................................................................11
4.2.Hardware Interfaces.................................................................................................................13
iv
4.3.Software Interfaces..................................................................................................................13
4.4.Communications Interfaces.....................................................................................................13
5.Conclusion.......................................................................................................................................15
6.Recommendations...........................................................................................................................16
7. References......................................................................................................................................17
Appendix A: Glossary of Terms...........................................................................................................1
Appendix B, Gantt Chart......................................................................................................................1
Appendix C: Software Design Diagram...............................................................................................1
Cover page.....................................................................................................................1
I. User Admin.................................................................................................................1
II. Review, Approve, Disapprove Topics.......................................................................1
Exit.................................................................................................................................1
Terms and Conditions....................................................................................................1
I. User Admin.................................................................................................................1
II. Topics........................................................................................................................1
Exit.................................................................................................................................1
Appendix D: Database Elements..........................................................................................................1
Appendix E: Screen Images.................................................................................................................1
E.1 Login Screen..............................................................................................................................1
E.2 Administrator Menu and First Screen........................................................................................2
Cover page.....................................................................................................................2
I. User Admin.................................................................................................................2
II. Review, Approve, Disapprove Topics.......................................................................2
Exit.................................................................................................................................2
E.3 Create Users...............................................................................................................................3
Cover page.....................................................................................................................3
I. User Admin.................................................................................................................3
II. Review, Approve, Disapprove Topics.......................................................................3
Exit.................................................................................................................................3
E.4 Delete Users...............................................................................................................................4
Cover page.....................................................................................................................4
I. User Admin.................................................................................................................4
II. Review, Approve, Disapprove Topics.......................................................................4
Exit.................................................................................................................................4
E.5 Select User to Modify................................................................................................................5
Cover page.....................................................................................................................5
I. User Admin.................................................................................................................5
II. Review, Approve, Disapprove Topics.......................................................................5
Exit.................................................................................................................................5
E.6 Modify Personal Information....................................................................................................6
Cover page.....................................................................................................................6
I. User Admin.................................................................................................................6
II. Review, Approve, Disapprove Topics.......................................................................6
Exit.................................................................................................................................6
E.7 Topics Sorted by Date Submitted..............................................................................................7
Cover page.....................................................................................................................7
I. User Admin.................................................................................................................7
II. Review, Approve, Disapprove Topics.......................................................................7
Exit.................................................................................................................................7
E.8 User Menu and First Screen......................................................................................................8
Terms and Conditions....................................................................................................8
I. User Admin.................................................................................................................8
v
II. Topics........................................................................................................................8
Exit.................................................................................................................................8
List of Figures
Figure 1 Context diagram for release 1.0 of the Report Topic Database System.................................5
Figure 2 Standard Header...................................................................................................................11
Figure 3 Software Menu Module Overview.........................................................................................1
List of Tables
Table 1 Database Elements...................................................................................................................1
vi
1. Introduction
1.1.
(Reference the source of the information about the project, Identify what follows as a Software Requirements
Specification, identify the product to be specified in this document, including the revision or release number,
give an overview of the contents and specify who is the intended audience. Note that this subsection does not
describe the project.)
This Software Requirements Specification for the ice-cream/cafe store Robocreams online
menu is submitted for partial fulfillment of the requirements of the course English for Computer
Science at the Vietnamese-German University and includes an overall description and listing of the
software functional and nonfunctional requirements for the project. Unless otherwise noted, all
requirements specified here are high priority and committed for release 1.0.
1.2. Audience
(Whom is this document written for?)
The intended audience of this document is the potential customers of Robocream, who will use
this website to see the palours products, services and events in order to decide if they want to use
Robocreams products or not.
The menu for Robocream will provide the customer with neccessary information about
robocream, such as availble products, upcoming products and events, robot and services,... The
website will be easy for the customer to navigate and search for informations. There will be some
effects but the website wont rely on them a lot as they may decrease the websites compability. If
the website is done well, it may bring a great deal of profit for Robocream and improve the palours
popularity.
This document provides the scope and context of the project to be undertaken, including the
background, feasibility, basic requirements for this project, and justification for it implementation. It
also specifies the user interface, presents an overall description and details the intended user groups
and the value that the system will have to them, and provides a schedule for the completion of the
project, including a list of all the deliverables and presentations required.
Robocream is a newly opened automated Cafe/Ice-cream palor with robot waiters founded by
the billionaire Diego Maradona. In order to expand its popularity, Robocream needs an online
menu. The online menu let customers choose what to buy before coming to Robocream. The
website can be considered as the face of Robocream so if done well, it will attract alot of customers.
The current system is primarily a manual system which Robocreams customers choose the
products they want to buy on a menu sheet then order them through a robot waiter.
Limitations of the current system include:
Customers wont be able to preview Robocreams products without coming to the palour,
which is very inconvenient.
Its too primitive in this day and age, especially for an ice-cream/cafe store with robot waiters.
Customers wont be able to check Robocreams events without co ming to the store.
The proposed Robocreams menu, version 1.0 will be a new system, replacing the current
manual method. The system will consist of a web-based front end tied to a SQL database. The
system consists of an Index page that acts as the homepage, several Menu and Our Story pages
contain information about Robocream and its products and the Admin page which is the only way
to manage and change the systems source code. The Admin page can only be accessed by those
who have a special account that is for internal circulation only. The context diagram in figure 1
illustrates the external entities and system interfaces for release 1.0.
Figure 1 Context diagram for release 1.0 of the Report Topic Database System
The Robocreams menu will consist of a series of modals which the users will access via a series
of menus. See Appendix C for an overview diagram of the system.
4
3.3.1. Administrator
The Administrator can gain access to administrative privilege through an internally circulated
account. With this privilege he/she will be able to make changes to the source code, which in turn
changes the websites structure and information. The administrator is responsible for debugging the
website and updating it regularly.
3.3.2. Users
Robocreams customers will be able to log in to the system as common users and gain access to
all of the information in the system, but arent able to change them.
The administrator will be provided with a short administrator manual that describes how to login
to the Admin page along with the account.
as software components that you intend to reuse from another project, unless they are already documented
elsewhere.)
3.7.1. Assumptions
During the development of this Software Requirements Specification the following assumptions
were made:
The administrator will be computer literate, able to perform simple administrative tasks.
The SQL database system will be managed by a trained administrator able to maintain the
system.
3.7.2. Dependencies
Successful implementation is contingent on the following factors:
a header (top section, 110 pixels in height, running the width of the page)
a center section divided into two parts (variable height, using rest of page)
and a footer (bottom section, 70 pixels in height, running the width of the page).
4.1.3. Header
The header or banner section will be an invisible table divided into three parts (25%, 50%,
25%) as follows:
4.1.6. Footer
The footer section will contain the following information
Questions and Comments (This will be a hyperlink to the webmasters email address)
Copyright 2015: The Vietnamese-German University (This will have a hyperlink to the home
page of the Vietnamese-German University)
Page last modified: <date> (This will show the last modified date of the document in the
contents window)
The Robocream project does not make use of any direct hardware interfaces and will only use
the windows operating system to communicate with hardware devices
The Robocream project will use client-server architecture. The client element will interface with
the user via an HTML interface. The server portion will consist of a SQL database running on a
university server.
4.4.1. TCP/IP
The Robocream project will use the TCP/IP protocol suite, version 6 as implemented by
Microsoft .
4.4.2. Web Browser
10
The Robocream project client interface will run on Firefox 3.0 or Internet Explorer 7.0 or
higher.
11
5. Conclusion
(The concluding chapter will include a summary of the preceding chapters and any conclusions drawn. Do
not introduce any new material in this section. )
The Robocreams menu, version 1.0 describes a simple to use, client-server system that uses a
web-based client interface linked to a server hosted SQL database, which will replace the existing
manual system. This system will allow users to access to Robocreams information, products,
events, prices. The contents and structure of the website can only be altered through an Admin page.
If done right, the project will boost Robocreams popularity and create some good word of mouth
from the users.
12
6. Recommendations
The Robocream project should be developed initially as a stand-alone system with the ability to
supply Robocreams guests with the information they need. Future developments should include
the followings:
A forum where users can state their opinions about Robocreams products and services
and discuss about its events.
A register and login system for users. Any user with an account can comment on the
products on the website and rate them. This means that the will also be a system and a
rating system.
13
7. References
(List here any references to other documents cited anywhere in this document including references to
related project documents. Follow the IEEE format specified in the Style Guide for Engineering
Reports. You should have at least five references.)
[1] About the Vietnamese-German University, TPHCM, VN:VGU 2012 [Online] available:
http://www.vgu.edu.vn/university/. [Accessed Jan. 30, 2012].
[2] The Study Preparation Course: Foundation Year, TPHCM, VN:VGU 2012 [Online] available:
http://www.vgu.edu.vn/studies/bachelor/fy/. [Accessed Oct. 10, 2012].
[3] R. Bradley, Syllabus: English for Computer Science, The Vietnamese-German University,
TPHCM, VN:VGU 2012.
[4] W3C, HTML 3.2 Reference Specification; W3C Recommendation 14-Jan-1997
The World Wide Web consortium (W3C), 1999 [Online] available:
http://www.w3.org/MarkUp/Wilbur/ [Accessed Oct. 22, 2008].
[5] R. Bradley, Style Guide for Web pages, The Vietnamese-German University, TPHCM, VN:VGU
2012.
[6] Microsoft, Introduction to IP Version 6, Redmond: Microsoft Corporation. Published: Sept.,
2003, Updated: Jan. 11, 2008 [Online] available: http://technet.microsoft.com/enus/library/bb726944.aspx [Accessed Jan. 5, 2009].
14
Client
SQL
VGU
Server
Circulated
internally
Term
Term
Term
Term
Term
Term
Term
A customer
Structured Query Language, a type of programming language
The Vietnamese German University
A computer or device on a network that manages network
resources.
Only for people in the company
Definition
Definition
Definition
Definition
Definition
Definition
Definition
A-1
chart showing your planned schedule for work on the phases of the project.)
Robocreams menu, Version 1.0
Status Date: 11 January 2016
Due Date: 14 January 2016
ACTIVITY
%COMPLETE
STATUS
Initial Proposal
100%
Analysis
100%
Database Design
80%
Interfaces design
60%
Coding
40%
Module Testing
25%
Implementation
10%
Date Ending
02/03/12
09/03/12
16/03/12
23/03/12
30/03/12
06/04/12
SSSS
SSSSS SSXX
BBSSSSS SSSX
SSSSSS SS
BSSSSS
BBB
SSSSS
BBBBB
S SSSSSS
Initial Proposal
S Scheduled
A Completed
23/03/12
C Caution
Test Plan
16/03/12
F Critical
Reference Manual
30/03/12
B-1
24/02/12
Student Menu
Cover page
I. User Admin
1. Create User
2. Delete User
3. Modify User
1. Topics by Submitted
Date
2. Topics by Student ID
3. Topics by Student
Name
4. Submit Topic
1. Topics by Submitted
Date
2. Topics by Student ID
3. Topics by Student
Name
Exit
Exit
C-1
Size
30
15
8
1
50
6
10
50
2000
1
1
15
D-1
Type
Text
Text
Text
Binary (M/F)
Text List
Text
Encrypted
Text
Text
Binary (Y/N)
Binary (Y/N)
Text - List
Help
Good Afternoon!
Today is 30 March 2012
Welcome To
The Report Topics Database System (RTDS)
Version 1.0
Username:
Password
Login
L og in
usernam e
Reset
Res et
E-1
Help
1. Create Users
2. Delete Users
3. Modify Users
Good Afternoon!
January 2009
S
10
11 12 13 14 15 16
17
18 19 20 21 22 23
24
25 26 27 28 29 30
31
Exit
E-2
Cover page
I. User Admin
1. Create Users
2. Delete Users
3. Modify Users
II.
Review, Approve,
Topics
Disapprove
Student's Surname:
Student's Given Names:
Student's Number:
Student's Sex:
Student's Department:
Student's Class Number:
Student's Password (10 char)
Male
Female
**** **
If you are sure that all you data is correct, click on the submit button
Submit
Reset
Exit
E-3
Help
Delete Users
Cover page
I. User Admin
Check to
delete
1. Create User
2. Delete User
3. Modify User
II.
Review, Approve,
Topics
Student
ID Number
Student
Name
Anh Duong
EEUN9999
Sung Yen
IUUN9998
If you are certain you want to delete the checked user, click on the Delete button.
Click on the Reset button to undo all of the checks.
Delete
Reset
De le te Ch ec ke dUs er s
Exit
E-4
Help
Modify Users
Cover page
I. User Admin
Click on the number next to the name to open a screen to modify that user's account
1. Create User
2. Delete User
3. Modify User
II.
Review, Approve,
Topics
Disapprove
Student
Name
Student
ID Number
Anh Duong
EEUN9999
IUUN9999
Sung Yen
IUUN9998
Exit
E-5
Help
Cover page
I. User Admin
II.
Review, Approve,
Topics
Student's Surname:
Student's Given Names:
Student's Number:
Student's Sex:
Male
Female
Student's Department:
Student's Class Number:
Student's Password (10 char)
If you are sure that all you data is correct, click on the submit button
Submit
Reset
Ki m
1. Create User
2. Delete User
3. Modify User
Anh Ng uy en
ITUN9999
Disapprove
IT9999
**** **
E-6
Help
Cover page
I. User Admin
1. Create User
2. Delete User
3. Modify User
II.
Review, Approve,
Topics
Student
Name
Student
ID Number
Topic
Nguyen
Thi Kim
VGU9999
Report Topic
Database System
10/01/2012
Yes
11/01/2012
Sung Yen
VGU9998
Report Topic
Database System
11/01/2012
No
11/01/2012
VGU9997
Solar Powered
Bicycle
13/01/2012
Yes
14/01/2012
Disapprove
3 Anh Duong
4
5
E-7
Date
Approved
Submitted Yes/No
Help
Date
Approve/Reject
Reason
Duplicate
1.
2.
3.
4.
Exit
Help
Use of this system constitute acceptance of the following terms and conditions:
1. All material and ideas submitted during the course become the property of the Vietnamese-German
University and can be used by the Vietnamese-German University for non-commercial activities.
2. All of the material provided by the instructor during this course are the property of the VietnameseGerman University and cannot be used for commercial purposes without the prior written consent of the
Vietnamese-German University and the author of the work.
3. Plagiarism: It is an Academic Offence to commit any act whereby a person seeks to obtain for
himself/herself, or for another, an unauthorized advantage with a view to achieving a higher mark or grade
than his/her abilities would otherwise secure. The substantial use of other peoples work and the
submission of it as though it were ones own is regarded as plagiarism. Work which is not undertaken in an
Examination Room under the supervision of an invigilator (such as dissertations, essays, project work
experiments, observations, specimen collecting, and other similar work), but which is nevertheless
required work forming part of the degree, diploma or certificate assessment, must be the candidates own,
and must not contain any plagiarized material.
E-8
E-9