You are on page 1of 25

SRS Document

A Software Engineering Project

Software Requirements Specification
(ver. 4.1)

Project Manager: Andy Project Name: QA Quetzals Company Name: At-A-Glance Software Contributors: Rani, Sudheera, Ambica, Rama & Robert Class: CS532, Concepts of Software Engineering – Summer ‘10

1

SRS Document

Submitted To Customer: Professor Robert Zhu Date: Saturday, June 7th 2010

Table of Contents
1. Introduction ...............................................................................................................................4
1.1 Purpose .......................................................................................................................................... 4 1.2 Document Conventions ................................................................................................................. 4 1.3 Intended Audience ........................................................................................................................ 4 1.4 Project Scope & Vision .................................................................................................................. 4 1.4.1 Goals .......................................................................................................................... 6 1.4.2 Market Context.......................................................................................................... 8 1.4.3 Stakeholders .............................................................................................................. 8 1.4.4 Key Features .............................................................................................................. 8 1.4.5 Constraints............................................................................................................... 10 1.4.6 Appendix & Use Cases ............................................................................................. 10 1.5 References ................................................................................................................................... 12 2.1 2.2 2.3 2.4 2.5 2.6 2.7 3.1 3.2 4.1 4.2 4.3 4.4 5.1 5.2 5.3 5.4 Product Perspective ..................................................................................................................... 13 Product Features.......................................................................................................................... 13 User Classes and Characteristics .................................................................................................. 14 Operating Environment ............................................................................................................... 16 Design and Implementation Constraints ................................................................................... 187 User Documentation.................................................................................................................. 187 Assumptions and Dependencies................................................................................................ 187 System Feature 1 ....................................................................................................................... 209 System Feature 2 ....................................................................................................................... 209 User Interfaces ............................................................................................................................. 20 Hardware Interfaces .................................................................................................................. 222 Software Interfaces ...................................................................................................................... 21 Communications Interfaces ......................................................................................................... 21

2. Overall Description ................................................................................................................133

3. System Features.......................................................................................................................19 4. External Interface Requirements ............................................................................................20

5. Other Nonfunctional Requirements .......................................................................................22
Performance Requirements ....................................................................................................... 232 Safety Requirements.................................................................................................................. 232 Security Requirements............................................................................................................... 232 Software Quality Attributes ....................................................................................................... 232

6. Other Requirements ..............................................................................................................232 7. Appendixes ................................................................................................................................23
7.1 Appendix A: Glossary ...................................................................................................................... 23 7.2 Appendix B: Analysis Models.......................................................................................................... 23 7.3 Appendix C: Issues .......................................................................................................................... 23

2

0 3 .2.doc SRS v4. 2010 th rd th th th rd Reason For Changes Use case correction Finalization for Mid-Term 2 Addition of Diagrams Addition of Requirements Submitting to Professor Robert Zhu Initial Verbal Customer Requirement Modified By Ranjeeta Rama Rama Rama Andy Andy Version 4.2010 July 16 .doc SRS v2. 2010 July 3 .0 2.2 4.0 3. 2010 June 30 . 2010 July 7 .0 1.SRS Document Revision History Name SRS v4.doc SRS v3.doc SRS v4.1. 2010 July 16 .doc Date July 23 .doc Requirement v1.1 4.

convenient and user-friendly tool that can be used by the upper management to review the bug trends within a particular software project.2 Document Conventions This SRS document does not contain any standards or typographical conventions. testers. marketing staff. graphs. Every requirement statement is to have its own priority. The goal of this software system is to be able to track and report all the bugs in multiple software products in a resourceful and well-organized way to its user so that the user can use that information to make important decisions 4 . It not only reduces the time involved in transfer of data and information from different levels of hierarchy in the project development life-cycle. and reports.SRS Document 1. Decision making is enhanced and simplified. but also gives the President or the CEO an instant birds-eye view of the overall health of the organization. The graphical user dashboard interface is simple. and documentation writers. Its main purpose is to test. project managers. This is of great benefit to the upper management staff in a company. users. It provides a report of the overall bug status information ‘at a glance’ in the form of charts. teaching assistants.4 Project Scope & Vision The software system specified here is used to deliver the output in a GUI format to the end user. 1. developers. 1.1 Purpose This project is undertaken to develop a graphical user dashboard interface that reports statuses of bugs arising from multiple on-going projects within an organization. 1.3 Intended Audience The different types of readers intended for this SRS document are HGU students. Introduction 1. identify and report bugs in a software product. inexpensive. professors.

The Context model of the system is as follows: 5 . Displays GUI content output using reporting tool and maintains the system as a whole using maintenance system. It is the highest level view of a system similar to the block diagram which depicts system as a whole and its inputs and outputs from/to external factors that lies outside the system boundaries. The high-level diagram of the software system is as follows: Projects (Java/WebApp) Manual Testing System High Level Diagram 4 3 1 2 Project vs. Processes data in Data processing unit. The User interacts with Dashboard Tool which derives inputs from databases and QA testing tool. Defect Graph Modify Code 4 1 2 3 Test OK? Fail Report Bug To JIRA Query JIRA DB / My SQL Data Base Dash Board Integrator P1 Issues Graph Pass Product Release 30% 15% 10% 45% Bug Criticalities Pie Chart 3 1 4 2 BRR Graph Context models are used to illustrate the operational context of a system. Checks security & safety policies for influence of external factors.SRS Document regarding an organization’s future.

Advantages and Disadvantages of V-Model are as follows: Advantages: 1. Reduces the cost for fixing the defect since defects will be found in early stages 4. It is a fast method. Avoids the downward flow of the defect 3.4.1 Goals To produce a user interface dashboard style product based on the application of software engineering principles and models. 2. 6 .SRS Document Safety & Security Policies JIRA DB My SQL Dashboard Tool QA Testing Tool Maintainence System Reporting Tool Data Processing Unit Context Model 1. Follow the Software Engineering philosophy of the OMG by producing first a VModel to facilitate the development process. The software testing platform will be performed in a manual testing environment that uses JIRA bug tracking software and Java technology will be used for coding purposes. The system will use a simple user Id and password mechanism to log in. It is also called as verification and validation Model. Proactive defect tracking wherein defects are found at early stages even may be in the development phase before application is tested. 5.

It emphasis the strict process flow to develop a quality product. Variables. BRD/Historical & Defect resolution rate UAT Planning UAT Dashboard Delivery SRS/Defect Vs Project System Test Plan System Testing HLD/Data flow In the mmodules Integ Test Planning Integ Testing LLD/Data Type. Naming conventio nnn Unit Test Planning Unit Testing Maintenance & Enhancement Project (Java) Classes V-Model 7 . 8. This means the verification and validation will be done side by side.SRS Document 6. The errors occurred in any phase will be corrected in that phase itself. 7.

making it likely to support updates in the near future. The list of the stakeholders and the specific individuals representing them are. 2.4. 1. On the other hand this technology has immense need in the market to put us at a competitive advantage if implemented now. 8 . Check the overall project status for each and every on-going project in the company.  Computer Science Engineering. 1. Robert 1.4. 3. It needs lot of resources and money. 5.4 Key Features The following are the key features of the software product:   A convenient user-friendly UI tool to allow the customer to obtain reports for each project.4. Requires more people to work.3 Stakeholders Among the stakeholders for this system are the Computer Science and Engineering Department. Zhu.SRS Document Disadvantages: 1. It can be implemented by only some big companies. It needs an established process to implement. 4. It is rigid and least flexible.2 Market Context The equipment currently on market does not support features that provide the people in the upper management level to check the overall system or project status for on-going software projects in their company. This technology has just begun the start of its useful life.

SRS Document GUI COMPONENT DIAGRAM TEAM INFORMATION BUG RESOLUTION RATE CRITICAL VS NON CRITICAL PROJECT INFORMATION DAILY/WEEKLY /MONTHLY Click the Graph Sign in PROJECTS VS DEFECTS LOGIN Sign off LIST OF PROJECTS Select Project PIE CHARTS HISTORICAL GRAPHS GUI Component Diagram Data flow diagram Requirement Test case INPUT PARAMETERS REQUIRMENT /TEST ANALYSIS FINDING BUGS Jira bug tool Open source Infrastructure DASHBOARD JIRA JIRA DATA BASE Historical/Bug resolution graphs OUTPUT GRAPHS Data Flow Diagram 9 .

SRS Document 1. but rather they should be considered equal.  Customer uses dashboard by logging in User Log In & Password Password Dashboard  Customer views list of on-going projects 10 . 1.6 Appendix The following are the actors that directly support this vision. The basic architecture as well as the infrastructure needed will be designed in-house.5 Constraints This project must be completed within two months or before August 21st 2010. Zhu. development and testing of the user interface tool.4. Neither the software nor the user interface shall be considered the independent variable. They should not be added to this list unless they are deemed to directly support the vision as described in this document. Close liaison will be maintained between the software design. Additional actors may be identified later that are needed to support this or that technology.4. They should not be added to this list unless they are deemed to directly support the vision as describe in this document. • Computer Science Department • Customer. Robert The following are the use cases that directly support this vision. Additional use cases may be identified later that is needed to support this or that technology or to support the use cases listed here.

Project 2 Defect Vs Project Project 3 Status Project n  User Interface to display the graphs of the selected project Team Info User Dashboard Project Vs Defect graph Historical Graph 11 .SRS Document Project 1 User Dash boar d List of Projects.

project scope and vision. author.SRS Document User Dashboard Project Vs Defect Status Rate resolution Graph 1. use case documents. software and tools.5 References This SRS refers to the project located at following web address: http://code.google. interface guides. 12 . including title.com/p/at-a-glance/ All documents including the project-plan. version number. date and source or location can be found on this website for your reference.

This product is using Java platform and the JIRA bug tracking tools. 2. trends and data visualizations. It is intended to implement the entire bug tracking features. Defect tracking is a critical component to a successful software quality effort. Overall Description 2.1 Product Perspective At a Glance is an innovative product for higher management in an organization to identify the state of the application. The possible extension for this product is connecting to multiple bug reporting tools. Follow the defect resolution process and work the defect from initiation to closure.SRS Document 2. metrics.2 Product Features See Appendix B 2. This product imports all the necessary java packages that are needed for task. Software defect data is the most important available management information source for software process improvement decisions. Defect tracking dashboard is a web-based defect and bug tracking solution to track product defects and manage product enhancement requests. Dashboard contains KPIs. 13 . charts. enhancing product quality and customer satisfaction. ignoring defect data can lead to serious consequences for an organization's business.3 User Classes and Characteristics An association model: Associations indicate that an attribute of an object is an associated object or that a method relies on an associated object.

Association Model Sub-System Model: 14 .SRS Document An association model generates HomePage DashBoard displays Status Login access Associations are indicate that an attribute of an object is an associated object or that a method relies on an associated object.

Homepage . Often you will see operations referred to as methods. Login.SRS Document Sub-System Interfaces Communication Interfaces Sub-Systems Data Collection Databases Dashboard UI Interface QA Tool Sub-Systems Applications/Gadgets Test Plan Test Cases JDBC JQL Input Parameters JIRA Security Permissions Report Collector Sub-System Model Class Diagram: A class is a system entity that models a real-world object. 15 . A class is made up of attributes which define the information that each class knows about itself and operations which are the processes that a class can carry out. Dashboard and Status are classes.

SRS Document Class Diagram State Diagram: Shows how objects respond to different service requests and the state transitions triggered by these requests. 16 .

512MB RAM.0 GHz processor. 250GB HDD Programming language: Java (JDK 1. State Diagram 2.4 Operating Environment The environment in which software will operate and other software components or applications with which it will co-exist are as follows: Operating System: Windows XP/Vista or higher Hardware platform (Minimum requirements): Quad/Dual core 2.5).SRS Document State Diagram drawChart() Displays graphs in dash board drawGraph() initialstate DashBoard getProj() Login Validate() Waiting signOut() goHome() goHome() signOut Graphs getStatus() Charts Status Status complete Shows how objects respond to different service requests and the state transitions triggered by these requests. JQL (JIRA Query Language) Programming Platform: Eclipse IDE Application server: Apache Tomcat DB: JIRA Standalone or WAR/EAR (Inbuilt)/ My SQL Browsers: Internet Explorer/Mozilla Firefox QA Tools: Bug Tracking Tools: JIRA Communication Tools: WebEx Subversion Tool: Tortoise SVN Reporting Tools: JIRA 17 .

T3. such as software components reuse from another project. online help.6 User Documentation There are no user documentation standards or components such as manuals. The project has no dependencies on external factors.5 Design and Implementation Constraints The following are the design and implementation constraints that might limit the options available to the developers and UI designers are as follows: Corporate policies: Atlassian's regulatory policies Databases: Memory constraints in JIRA (need to take frequent back-ups) Design Conventions: Limited customization of filters/permissions (Due to trail version) Security considerations: Inbuilt Atlassian's security advisories 2.T10(M6) 18 . and tutorials available for delivery along with this software. Task dependencies and Activity Network Diagram indicating critical path are as follows: Work Tasks Breakdown T1 T2 T3 T4 T5 T6 T7 T8 T9 T10 T11 Andy All All Andy All Ambica/Andy All Rani Rani/Andy Rama/Sudheera All Task Description Client Interview Feasibility Study Requirements Analysis Project Planning Process Flows Object Oriented Analysis System Models Manual Testing Bug Reporting UI Integrating Final Delivery Critical Path = 27 Days Duration (days) Dependencies 3 4 12 7 3 T1.SRS Document 2.T4(M5) T7.T9. 2.7 Assumptions and Dependencies There are no assumed factors (as opposed to known facts) that could affect the requirements stated in the SRS.T3(M1) 3 7 10 7 12 3 T5(M3) T5.T6(M2) T8(M4) T1.T2.

SRS Document 7 Days 12 Days 12 Days Task 4 Task 3 3 Days M5 Task 10 M3 3 Days Task 6 7 Days 3 Days 3 Days Start Task 1 4 Days M1 Task 5 7 Days M2 Task 7 M6 Task 11 Finish Task 8 10 Days Task 2 M4 Task 9 Activity Network Diagram 19 .

) o User ID must be of minimum length of 5 characters.1.2 System Feature 2 More system features will be added following the design process. o User ID field is allowed to have only of the following characters: [0-9]. o When GRAPH is selected the user can see a graph with Project Release Date in ‘X’ axis and Defects in ‘Y’ axis.2 Stimulus/Response Sequences NA 3. [a-z]. [A-Z]. and GRAPH.SRS Document 3. Special characters allowed are: underscore (_) and period (. 3. o The system must display the following error message if the user ID entered is not valid. o “User ID Invalid” o Password should be minimum 4 characters long.1 System Feature 1 3. 20 .1. o The user should not be allowed to access the application with incorrect Login. o User ID field name must be displayed as “User ID” in the UI.) REQ-2: UI page requirement: (Dashboard page fields) o User should be able to see the fields on the dashboard like PROJECTLIST. o Dashboard should have an option to select RELEASES. o The user should be allowed to access the application with correct Login. o User ID must be of maximum length of 10 characters. Lower case.1 Description and Priority NA 3. RELEASES. 3. Numeric and special characters. o Password can include alphabets. Upper case.3 Functional Requirements REQ-1: Login page requirement: (Fields: User ID and Password). System Features This section illustrates the functional requirements for the product by system features.1. the major services provided by the dashboard product.

Excel Standard buttons and functions appear on each screen: Proposed tabs in dashboard are as follows     Home or Dash boards & Gadgets Browse List of Project Find P1 Issues View historical data and BRR graph for each project Software components: JAVA. 21 . Menu design Security to ensure the quality of the content User Interface with JIRA: Web. JAVA API. LDAP. linear or column graphs. My SQL/ JDBC.            Concise. numbered guidelines Navigation b/w major interface items & navigation with in a screen Wording messages and labels Quality assurance checklist Align fields effectively & Justify data appropriately Visual design patterns to solve common design problems Comprehensive.such as day. So we follow the GUI standards in following points in designing the dashboard and the user interface. month or year. My SQL/ Oracle Reports/ Figures: The reports need to be created in a variety of dimensions. workflow. the way in which it provides that functionality is also important. Data should reflect the amount of issues for each individual customer. the number of issues reported over a specific time frame . week. and statistical tables. External Interface Requirements 4. email. Clear case.1 User Interfaces User interface of an application will make or break. including pie chart. customizable administration tools Common buttons on forms Drop down menus Tool bars.SRS Document 4. Although the functionality that JIRA tool provides to user is important.

charts for selected period of time Information related to the defects will be shared across the software components.3 Software Interfaces        Operating system requirements: Windows XP or higher Database requirements: Using inbuilt databases that comes with the bug tracking tool Tools: A bug tracking tools like JIRA Library requirements: Proposed to use java libraries Incoming messages: No specific user defined messages: But this tool will display the graphical representation of the defect trends in the form of graphs. and many other options. 4. Google Web Browsers: Internet Explorer6. SMTP Other Communication Interfaces: Inbuilt JIRA gadgets/plug-ins 22 . HTTP.0 or higher Networking protocols: FTP.2 Hardware Interfaces There is no communications protocol and hardware interface characteristics implementation of the dashboard product.4 Communications Interfaces The following are the communications functions such as email. web browser.x or higher. Mozilla Firefox3. 4. 4. No implementation constraints identified by this time.SRS Document the average time to resolve an issue. Google Code Mail Clients: Microsoft Outlook Express. network communications protocols and other inbuilt communication interfaces to be used: Communication Platform: WebEx.

Other Nonfunctional Requirements 5. The database is securely stored and has a full 128 bit SSL encryption model supporting the security requirements.1 Performance Requirements As of now there are no performance requirements for the product under various circumstances. 6. such as internationalization requirements.4 Software Quality Attributes A desired combination of quality attributes focused for this project is its timeliness. The Disaster recovery site has been setup to back-up data for any possible loss or damage if incurred during any natural disaster. Other Requirements No other requirements exist outside the scope of this SRS document. reaps the long-term benefits of improving the customer's ROI. 5. interoperability of the dashboard tool. Documenting company's security policies & procedures for effective security implementations. Encapsulation and encryption features available for data/file transfer.3 Security Requirements The software product will have a simple user Id and password screen to authenticate the user information and will not be accessible to non-managerial staff thereby restricting editing/viewing of dashboard pages.SRS Document 5. 23 . legal requirements. Security measures from potential intrusive threats and hardware/software crashes. This combination tradeoff not only satisfies the user requirements and ensures a better quality system but also. reuse objectives for the project. 5. and so on.2 Safety Requirements The database is stored in multiple data centers across the company’s network and would be accessed from any geographical location. 5. ease of use.

SRS Document Appendix A: Glossary The following are the interpretation of terms. The project has some open requirements issues that remain to be resolved. acronyms and abbreviations for this SRS document: JQL JIRA Query Language Appendix B: Analysis Models Appendix C: Issues List The first and final release for this product is planned to be in August 21st. The conflicts awaiting resolution are whether to use Database management or XML based data from the tracking tool software to read the input into the final output display board. 2010. Information is needed on what is the optimum way to connect the JIRA bug tracking tool to a dashboard reporting software tool. 24 .

SRS Document 25 .