srs

15
(BHG1611) (Team Name) Software Requirements Specification Document On Issue tracking System Version: (n) Date: (02/08/2011)

Upload: krunal-zalavadiya

Post on 31-Aug-2014

208 views

Category:

Documents


8 download

TRANSCRIPT

Page 1: SRS

(BHG1611)

(Team Name)

Software Requirements Specification

Document

On

Issue tracking System

Version: (n) Date: (02/08/2011)

Page 2: SRS

Table of Contents

1. Introduction1.1 Purpose1.2 Scope1.3 Definitions, Acronyms, and Abbreviations1.4 References1.5 Overview

2. The Overall Description2.1 Product Perspective

2.1.1 System Interfaces2.1.2 Hardware Interfaces2.1.3 Software Interfaces2.1.4 Communications Interfaces

2.2 Product Functions2.3 User Characteristics2.4 Constraints2.5 Assumptions and Dependencies

3. Specific Requirements3.1 External interfaces3.2 Functions3.3 Logical Database Requirements3.4 Design Constraints3.5 System Requirement Study

3.6.1 Reliability3.6.2 Availability3.6.3 Security3.6.4 Maintainability3.6.5 Portability

3.6 Organizing the Specific Requirements3.7.1 User Class3.7.2 Feature3.7.3 Functional Hierarchy

3.7 Additional Comments

1. INTRODUCTION

2

Page 3: SRS

1.1 Purpose: The purpose of the issue tracking system:

In such situations, when there are constantly new requirements coming, tools are necessary, which would allow somebody to fully and easily:

Share the information across the team. Have an instant overview of the state of the software. Expertly decide about releasing. Set and update the importance of individual fixes and adjustments. Have a recorded history of changes.

1.2 Scope: Each issue represents a work item that project members must resolve. Each issue is reported by a user who enters an initial summary and description. Issue descriptions are best written from the user's perspective, detailing facts about the problem or need as they see it, rather than getting into solution plans or implementation details so for that issue tracking system

Improve the quality of software. Increase satisfaction of users and customers. Ensure requests accountability. Improve communication in the team and also to customers. Increase of productivity of the team. Reduce expenses.

1.3 Definitions, Acronyms, and Abbreviation:“A software application that allows recording and following the

progress of identified problem or “issuing" until the problem is resolved”

Process: set of interrelated or interacting activities which transform inputs into outputs.

Activity: a set of cohesive tasks of a process.

Task: required, recommended, or permissible action, intended to contribute to the achievement of one or more outcomes of a process.

3

Page 4: SRS

Sub-Task: When a task is complex, it is divided into sub-tasks.

Step: In a deployment package, a task is decomposed in a sequence of steps.

Role: A defined function to be performed by a project team member, such as testing, filing, inspecting, coding.

Product: Piece of information or deliverable that can be produced (not mandatory) by one or several tasks. (e. g. design document, source code).

1.4 References

[1] http://www.redmine.org/projects/redmine

[2] http://trac.edgewall.org/wiki/TracGuide

[3] https://wiki.mozilla.org/Bugzilla [4] http://www.bugzilla.org/docs/2.18/html/integration.html

1.5 Overview: Allows the users of the system to save time and reduce the cost of issue tracking. Allows the dynamic generation of issue tracking modules for different applications and projects. Provides for a good methodology for systemic process improvements

1. Installation and initial configuration Brief introduction into systems environment requirements and

explanation how difficult is it to setup the tracking system for initial use. 2. User interface and learning curve

Some system user interfaces are more user friendly than others. Shown (if possible by screenshots) are typical use cases “Creating new and looking for a ticket”.

3. Ticket system It is expected that the system allows the setup of workflow

and to add custom attributes. Here, the investigation will show how difficult it is to change default workflows, if it is possible to add or modify custom attributes, and what steps are needed to make this happen.

4

Page 5: SRS

4. Projects management The possibility to handle more projects within one instance of

tracking system will be discussed 5. Analysis and monitoring

The kinds of statistics, graphs, and other monitoring resources that are provided by the tracking system will be shown. 6. Source code management systems integration

Here, a short summary will be provided about the possibility to connect various versions of control systems with the tracking system.

7. Accessibility and extensibility The reader will see the possibilities of extending basic functionality of the tracking system by plug-ins, and learn about its accessibility from other systems.

2. The Overall Description

This is an enhanced wiki and issue tracking system for software development projects. This uses a minimalistic approach to web-based

5

Page 6: SRS

software project management. Our mission is to help developers write great software while staying out of the way. This should impose as little as possible on a team's established development process and policies.

2.1 Product PerspectiveThis allows wiki markup in issue descriptions and commit messages,

creating links and seamless references between issues, tasks, change sets, files and wiki pages. A time tracking shows all current and past project events in order, making the acquisition of an overview of the project and tracking progress very easy. The milestone part is listing the upcoming milestones. Discussion panel is used for discuss on different issues and also about for their possible solutions.

2.1.1 System Interfaces

This is web based application which is usable form anywhere in to the world. For use this application open it in to the web browser and login in to the system and you can use the functionality of that system from anywhere.

2.1.2 Hardware Interfaces

Pentium 4 processor

Server Configuration: Hard-disk space: 30MB RAM : 1GB

Client configuration: RAM : 512 MB

2.1.3 Software Interfaces

JVM (java virtual machine) & JRE (java runtime environment) are the mainly two s/w interfaces required for this system.

2.1.4 Communications Interfaces

For this application transparent web services are used.

2.2 Product Functions

6

Page 7: SRS

Tickets: Ticket database provides simple but effective tracking of issues and bugs within a project.As the central project management element tickets can be used for project tasks, feature requests, bug reports, software support issues among others.Tickets have been designed with the goal of making user contribution and participation as simple as possible.

Wiki: Wiki system use for organizing knowledge and information in a very flexible way by creating pages containing an intuitive and easy to learn textual markup.

Milestone: The milestone provides a view on the ticket system that helps planning and managing the future development of a project.

Discussion panel: Into this part we can discuss on the various topic of the system like different type of issues and their solutions and also on milestones etc.

2.3 User Characteristics There is mainly two user of the system Manager and user or

member. There is all the content is under the Manager person who having their personal account and password who having right to change in the content of the system. On the other hand users/developers has important role in this application as they complete the task assigned to him and submit it to the assignee.

2.4 Constraints This system has some limitation one of them is we can’t run more

than projects on it at a same time. Also we cannot upload big file in to this project documentation.

2.5 Assumptions and DependenciesFor this system assume that your system web browser support this

application and also all JavaScript is also supportable by the browser. All necessary drivers and plug-in are installed in to the system.

7

Page 8: SRS

3. Specific Requirements

This part of the SRS contains all the information about the specific requirement of the system. This part includes what our product do in the current system. This part also contain requirement of software at a level which provide use full detail to designers.

8

Page 9: SRS

3.1 External InterfacesThe following section discusses the requirements related to the

interfaces used to communicate with external entities. These entities include human users and other hardware and software interfaces that permit the system to carry out its tasks.

3.1.1 User Interfaces

The requirements presented in this section describe the interfaces for issue tracking system. The requirements do not assume a particular interface; however, the requirements are grouped according to the main features (as defined by the use cases) provided by the system.

3.1.1.1 Interface Formats

The entire screen will have the name of the system, displayed on the screen.

After the login screen, all screens will provide the user with the ability to navigate through the system i.e. to select different function of the system.

The user will have the option to save changes to information stored in local database.

The user will have the option to cancel a submission to local database.

The user will have the option to print displayed information.

3.1.3 Software InterfacesThe system will interface with the following software system:

MySQL

3.1.4 Communications Interfaces

The system will run over the existing web network. The system will be developed as a client-server application with the server providing data access service only.

3.2 Functions3.2.1 User Role – Developer

Functions provided on the member sides are:- Developer has responsibility to accomplish the task assigned

to them.

9

Page 10: SRS

Developer submits the accomplished task to the Manager with the bug report and the file containing the bug.

Developers also provide the status or progress of the task assigned to them.

3.2.2 User Role – Manager

Functions provided for the Manager are:- The main job of Manager is to assign the issue to the

developers. Manager can see the details status of the issue and the

progress of the issue by each developer. Manager also provides the priority to each issue. Submitted issues if resolved get approved by the Manager

after testing from the testing department. Manager has all rights to divide the task and assign to the

particular developer.

3.3 Performance Requirements

Issue can be assigned and submitted as the issues arisen or issue resolved respectively.

The system should be able large no of users as this is a web application.

Larger than 10Mb of file are not allowed to be uploaded for each project.

This system is applicable only for the single project.

3.4 Logical Database RequirementsThis section describes requirements associated with a database. The

database schema will be provided at a later date. All information related to the status, priority, duration, percentage complete, file containing bug are stored in local database. All the information about the developers are stored in local database and only accessible by the Manager. For database we use MySQL for the system.

3.5 Design Constraints

10

Page 11: SRS

The system need to design base on the code, file management, database Eclipse, Tomcat server, Spring Framework. This system contain all data about following components

Developers can access the data or can accomplish the task from anywhere in the world where internet is available. Developers can download the file related to their issues and can use them to resolve the issue.

Once the issue get resolved; developers change the status to resolved and upload the file containing the bug.

3.6 System Requirement Study (System Attributes)3.6.1 Reliability

Reliability is the ability of a person or system to perform and maintain its functions in routine circumstances, as well as hostile or unexpected circumstances. This system is reliable to the user. Only Manager has all the right for the system. This system fulfill the requirements of the user.

3.6.2 Availability

The data in the database are stored in the most secure manner. There is a separate server to handle the database so that the data would be easily maintained. Data related to issue tracked and all the information related to the assigned issues are available to the assigned developers.

3.6.3 Security

The system needs to log client’s information of registration such as IP address and time for security purpose.

Password should encrypted and store in the database. Manager having personal account and password for that. Issue related information is only seen by the person who has duty to

complete the task. All task performed by him/her can be seen by him/her or Manager.

3.6.4 Maintainability

There is no external maintain ace of the system. Manager can make change in the item menu and all other thing which is displayed to the user. There is graphical user interface provide to the Manager by which Manager easily understood and easily change contains of the pages.

11

Page 12: SRS

3.6.5 Portability

This web application is written in the java language which is platform independent language so portability of the program is easily possible to different operating system.

3.7 Organizing the Specific Requirements3.7.1 User Roles

There is mainly two user of the system Manager and user or member. There is all the content is under the Manager person who having their personal account and password who having right to change in the content of the system. On the other hand users/developers has important role in this application as they complete the task assigned to him and submit it to the assignee.

3.7.2 Features

A feature is an externally desired service by the system that may require a sequence of inputs to effect the desired result. This system is semi automatic system that is based on computer and not requires extra efforts. Developers complete the assigned task and try to resolve the issue and maintain the file along this. So two thing need to be maintained by the developers i.e resolving the issue as well as maintaining the file containing the bug as well which line causes the bug in the project.

3.7.3 Functional HierarchyToday in every industry has its own issue tracking system to track

the issue arises in the development of their project. Issue tracking system is also sometimes called as bug tracking system as it tracks the bug of the project and assign to the developers to resolve the bug.

3.8 Additional CommentsThis system can be extended for tracking the issue of multiple

projects.

12