srs traceability managment

30
Traceability Management System Software Requirements Specification Draft Version 1.0 Page 1 of 30

Upload: aditya-rola

Post on 13-Jul-2016

9 views

Category:

Documents


0 download

DESCRIPTION

software requirement secification

TRANSCRIPT

Page 1: SRS Traceability Managment

Traceability Management System

Software Requirements Specification

Draft Version 1.0

Page 1 of 24

Page 2: SRS Traceability Managment

Contents

1. Introduction........................................................................................................................................4

2. Purpose...............................................................................................................................................4

3. Scope..................................................................................................................................................4

4. Definitions, Acronyms and Abbreviations...........................................................................................4

5. References..........................................................................................................................................5

6. Overall Description.............................................................................................................................5

7. External Interface Requirements........................................................................................................7

8. Functional Requirements....................................................................................................................8

9. Non Functional Requirements..........................................................................................................11

9.1 Usability.....................................................................................................................................11

9.2 Security......................................................................................................................................11

9.3 Performance..............................................................................................................................12

9.4 Capacity.....................................................................................................................................12

9.5 Recovery....................................................................................................................................12

9.6 Availability.................................................................................................................................13

9.7 Reliability...................................................................................................................................13

9.8 Maintainability...........................................................................................................................13

9.9 Portability..................................................................................................................................13

9.10 Privacy.......................................................................................................................................13

Page 2 of 24

Page 3: SRS Traceability Managment

Revision History

Name Date Reason For Changes Version

Ashwin,Umang, Sapan

14/02/16 First documentation of the SRS document for Defect and submission Management

Version 1.0

Page 3 of 24

Page 4: SRS Traceability Managment

1. Introduction

Traceability is a property of an element of documentation or code that indicates the degree to which it can be traced to its origin. It is the process of recording logical links between individual requirements and other system elements. Tracing can be done in both forward and backward fashion. A single functional requirement can be traced backward to its origin, such as a use case, product feature or business rule or trace that functional requirement forward into the bits of design, code and test cases.. It supports numerous software engineering activities like change impact analysis, compliance verification or trace back of code, regression test selection and requirements validation by using varied techniques. It enhances the team productivity and provides a perspective about the project.

2. Purpose

The purpose of this Software Requirements Specification (SRS) document is to describe the overall behavior of Traceability Management System (TMS). This SRS defines and describes the operations, performance, and quality assurance requirements of the TMS that is to be developed. This document also describes the nonfunctional requirements. It also describes the design constraints and technologies that are to be considered when the system is to be designed, and other factors necessary to provide a complete description of the requirements for the system. This Software Requirements Specification (SRS) captures the complete software requirements for the system. Requirements described in this document will be used as guidelines to develop the Traceability Management System.

3. Scope

Traceability management tool aims at automation of the following processes:

Generation of Reports of the various processes involved in the entire course of the product Creation of Various Self Explanatory Models and graphs of each stage involved in the

development of the product. The Traceability matrix is explicitly provided for facilitating overview of the product and the

completeness of the product. A Model for Management of the Changes made in the project over a period of time

Page 4 of 24

Page 5: SRS Traceability Managment

4. Definitions, Acronyms and Abbreviations

Abbreviation DesignationTMS Testing Tool Management

SystemSRS Software Requirements

Specification

5. References

6. Overall Description

6.1 Product Perspective

Testing Management system will help users to test their codes .There would be two columns one for expected output and actual output. If the actual output of user doesn’t matches with expected output then the user can submit their problem by using the form. The status of defect will show pending if the defect is not rectified and after the rectification of defect the status of problem will show problem solved. The problem of the user is registered by a unique id and is solved by skilled programmers. The solution is then posted by the programmers.

Page 5 of 24

Page 6: SRS Traceability Managment

Overview of the proposed system

6.2 Product Functions

The following are the user requirements for the system

6.2.1 The tester assigned to the test case can enter the defect for the test case by entering the following details.

6.2.1.1 Defect Description

6.2.1.2 The other details given below are automatically filled.

6.2.1.2.1 Project Name

6.2.1.2.2 Test Case Name

6.2.1.2.3 Tester Id –The defect details are assigned by the tester for the test case.

6.2.1.2.4 Programmer ID –The programmer responsible for the test case.

6.2.1.2.5 Defect open Date – Current date and time

6.2.1.2.6 Status – Open

6.2.2 The Programmer assigned to the test case can view the following details about the defect for the test case he has be assigned. The Project Manager can view all the defect test case details.

6.2.2.1 Input

6.2.2.2 Actual Output

6.2.2.3 Expected output

6.2.2.4 Test Case ID

6.2.2.5 Project ID

6.2.2.6 Requirement ID

6.2.2.7 Defect ID

6.2.2.8 Defect Description

6.2.2.9 Tester Assigned

Page 6 of 24

Page 7: SRS Traceability Managment

6.2.2.10 Assigned Date and time

6.2.2.11 Programmer Assigned

6.2.2.12 Status of the defect

6.2.2.13 Closed Date

6.2.3 The Programmer assigned to the defect can enter the solution of the defect for the test case by entering the following details.

6.2.3.1 Defect Solution Description

6.2.3.2 The other details given below are automatically filled.

6.2.3.2.1 Defect Close Date – Current date and time

6.2.3.2.2 Status - Close

6.3 User characteristics

End users should have basic knowledge of computer systems to adapt to the form based user interfaces offered by the system with sufficient documentation and end user training.

TESTER: He is the person who will test the code and finds is there any difference between actual and expected output.

PROGRAMER: He is the person who rectifies the errors and gives the solution of problem. PROJECT MANAGER: He can view all the defect status of all programmers.

6.4 Constraints

6.4.1 Migration of all existing problems registered by users to the database. 6.4.2 Separate database for the debugged solutions issued by programmers.6.4.3 Solution can’t be posted without getting it tested from the tester.

6.5 Assumptions and dependencies

6.5.1 Solution of the problems would only be issued to the users after they are successfully tested by the users.

Page 7 of 24

Page 8: SRS Traceability Managment

7. External Interface Requirements

7.1 User Interfaces

7.1.1 The system will provide GUI for the users.

7.1.2 Message display when we click on button.

7.1.3 Standard buttons, functions, or navigation links that will appear on every screen, such as a help button.

7.2 Hardware Interfaces

7.2.1 To use TTMS, you will need a PC (regardless of its operating system, it can be Windows, Linux) or Mac. The system requirements are

1. CPU: 2 x Intel Core 2 (2.66 Ghz, 128K cache)

2. RAM: 2GB

3. Minimum database space: 10GB

7.2.2 If system doesn’t have touch input, a keyboard will also be required by the user to provide input.

7.3 Software Interfaces

7.3.1 The system will have an interface with the problem posted by the users and solution issued by programmers.

7.4 Communications Interfaces

7.4.1 The system will use click once deployment technology of the windows .net framework where in windows form based applications can be accessed through http over the internet. The web Browsers include

Internet Explorer 10, 11 & Edge Firefox (recent versions). Chrome, Safari, Webkit (recent versions).

Page 8 of 24

Page 9: SRS Traceability Managment

Project ManagerProject Manager

8. Functional Requirements

8.1 Use Case Diagrams

Page 9 of 24

1. LOGIN

2. Requirement Tracing

3.Version Modeling

4.Traceability Matrix Generation

Page 10: SRS Traceability Managment

Project Manager

Project Manager

Page 10 of 24

5. Report Generation

6. Model Generation by admin

7. Model Generation by Project Manager

Page 11: SRS Traceability Managment

8.2 Use Case Scenario Description

Use Case ID 1

Use Case Name Log In Page

Summary Project Manager and admin will have their log in IDs. First they have to choose which user class they belong to. A login page will be provided. Where they can enter their user name and password for user verification. The first page consists of following

Program Manager Log In

Admin Log In

After choosing the user type they will be redirected to second page. Which consists of following

Enter Username text field

Enter Password

Forgot Password

After the user enters the details their username and password will be verified from database. In case the user forgets his password. Then on clicking the “forgot password” link the password will be sent to his registered Email ID.

Preconditions User must have his credentials in the database.

Success End Condition

You have logged in Successfully Message is displayed to the user.

Failed End Condition

If User could not provide his right details.

Primary, Secondary Actors

Program Managers and admin who will enter the details for verification.

Page 11 of 24

Page 12: SRS Traceability Managment

Trigger -

Description Step Action

1 The End user opens the first login Page.

2 End user will select his user type.

3 User will be redirected to the second page.

4 User will enter the user name and password for verification.

5 If the user name and password get verified “you have logged in successfully” message will be displayed.

6 In case the user forgets his username. He will click on the “forgot password” link. Password will be sent to his registered Email ID.

Page 12 of 24

Page 13: SRS Traceability Managment

Use Case ID 2

Use Case name Requirement Tracing

Summary

After selecting the requirement ID from the given list of requirements in the combo box, the user accountable for the project can trace requirement changes for the project with model generation by choosing one of the methods (radio buttons) given below :

1. Generate model with last n requirements.

The following options will be enabled.

➢ TEXT FIELD: The user has to enter the number of requirements revisions; he wants a track of from the updated one.

2. Generate Model with revisions during selected Dates.

The following options will be enabled.

➢ DATE CALENDAR: The FROM and TO date should be selected from date picker and the following options can be selected.

3. Generate Model with ALL revisions till date.

➢ TRACK: The user can generate the model by clicking the button “TRACK” and fetch the revision traces of a particular requirement.

4. Export as PDF: The user can download the model or mail by entering the e-mail addresses of the recipients.

Preconditions • The Admin or Project Manager must be authorized and logged in.

Page 13 of 24

Page 14: SRS Traceability Managment

Success End Condition ‘The Email sent Successful’ Confirmation Message is displayed to the User.

Failed End Condition

‘Please enter valid email address’ message is displayed to the Project Manager when wrong mail Id is written.

Primary, Secondary Actors Admin, Project Manager

Trigger This use case is initiated when user clicks on ‘Requirement Tracing’.

DESCRIPTION Step Action

1 The User selects the requirement id from the combo box.

2

2a

2b

2c

The user chooses a model generation method based on revisions.

(Only one option can be selected from the three options available.)

If the user selects, Last n changes, follow step 3

Else If the user selects, Select dates, follow step 4

Else If the user selects, All changes, follow step 5

3The user has to enter the number of requirements revisions, they wants a track of from the updated one in the text field and follow step 5.

4 The user should select the FROM date and To date and follow step 5.This step will basically give the updates made during that time period.

5The User clicks on TRACK to generate a model.

The user can save the model details by clicking Export as PDF.

5a

5b

5c

The user clicks on MAIL REPORT to mail to the recipients. (it will direct you to the page “Report_send_mail”)

The user enters the emails address of the recipients in the specified text box.

Click on Send button to send the mail and get a message whether the mail has been send or not.

Page 14 of 24

Page 15: SRS Traceability Managment

Use Case ID 3

Use Case name Version Modeling

Summary The user is supposed to enter the version id of the respective project, it wants to generate the model for. It immediately pops up with the recent statistics on that particular version.

Now onwards, the user will be able to generate the model and perform various decision making and analytical process. Also, the documentation could be downloaded as a PDF and mailed to concerned people.

Preconditions • The Admin or Project Manager must be authorized and logged in.

Success End Condition

‘The model generated’ successfully and we can see about the test cases, design, requirements for a given version.

Failed End Condition

If the model doesn’t get generated then the colors version (root node) doesn’t changes into green.

Primary, Secondary Actors Admin, Project Manager

Trigger This use case is initiated when user clicks on ‘Version Modeling’.

DESCRIPTION Step Action

1

The User selects the version id from the combo box.

The recent status pops up with details like last updated, members involved etc.

Follow step 2.

2The User clicks on Generate Model button to generate a model.

The user can save the model details by clicking Export as PDF.

Page 15 of 24

Page 16: SRS Traceability Managment

2a

2b

As soon as user clicks on Generate Model the model gets generated.

That model will shown in two colors red and green where green refers to selected item for our project i.e. whatever things are green are required for our project (test case, design,requirement,version).

Use Case ID 4

Use Case name Traceability Matrix Generation

Summary The entire perspective of the project is generated using the traceability matrix. The matrix consists of various attributes that include system IDs, project IDs within the system as well as the requirement IDs for the given project as well as the design descriptions and the test cases in a form of a tabular matrix.

Whenever a change occurs in any of the attributes, an intermediate matrix is generated upon the request of the user.

The entire details regarding a particular requirement, test case or a design description is provided through a hyperlink enabled on the respective attribute.

The final updated matrix is available in a pdf format for the managers usage.

Preconditions

The manager must poses a valid login address to access the matrix.

The databases for the project, designers, test cases must be predefined

and permanent.

Success End Condition

The matrix is generated and is available in a pdf format for the usage of the project manager.

Failed End Condition An error message will be displayed indicating the details of the failed condition.

Primary, Secondary Actors Project Manager and a system administrator.

Trigger This use case is initiated when Project Manager clicks on ‘Generate matrix’.

DESCRIPTION Step Action

1 The manager selects the system for which the matrix has to be generated.

Page 16 of 24

Page 17: SRS Traceability Managment

2

3

4

The Project Manager clicks on the Generate matrix button.

The entire summary of the system is displayed to the user.

If and when the user desires the complete details regarding any of the attributes a hyperlink thus enabled will perform the task.

5 The respective windows will be displayed containing the attribute’s ID and its description.

6The case when multiple test cases have to be reviewed simultaneously, clicking on the respective check boxes, we can submit using the submit button.

7 The above matrix is available to download in a PDF format for the usage of the manager.

Use Case ID 5

Use Case name Report Generation

Summary The Project Manageraccountable forthe project and admin can generate reports for his project by choosing one of the methods given below

METHOD 1: Report on Status of Project Components. The following options will be enabled.

GENERATE REPORT: The project manager and admin can generate the report and save the report as a softcopy. Also he can take printout.

MAIL REPORT: The project manager and admin can mail the report by entering the e-mail addresses of the recipients.

Page 17 of 24

Page 18: SRS Traceability Managment

METHOD 2: Report on completed components during selected Dates.The following options will be enabled.

DATE CALENDER : The FROM and TO date should be selected and the following options can be selected

GENERATE REPORT: The project manager and admin can generate the report and save the report as a softcopy. Also he can take printout.

MAIL REPORT: The project manager and admin can mail the report by entering the e-mail addresses of the recipients.

Preconditions The Project Managerand admin must be authorized and logged in.

Success End Condition ‘The Email sent Successful’ Confirmation Message is displayed to the user.

Failed End Condition

‘Please enter valid email address’ message is displayed to the userwhen wrong mail Id is written.

Primary, Secondary Actors Project Manager, admin

Trigger This use case is initiated when userclicks on ‘Generate Report’.

DESCRIPTION Step Action

1 The user clicks on the Generate Report button.

2

2a

2b

The user chooses a report generation method.

If he clicks on Report on Status of Project Components, follow step 4 or 5.

If he clicks on Report on completed components during selected Dates, follow step 3.

3 The user should select the FROM date and To date and follow step 4 or step 5.

4a

4b

The user Clicks on GENERATE REPORT to generate Report.

The user can save or print the report.

Page 18 of 24

Page 19: SRS Traceability Managment

5a

5b

5c

The user Clicks on MAIL REPORT to mail to the recipients.

The user enters the email address of the recipients in the specified text box.

Click on Send button to send the mail.

Use Case ID 6

Use Case name Model Generation by admin

Summary The admin for the project can generate models for any project by choosing the method given below

METHOD 3: Model for Project. The following options will be enabled.

SELECT MODEL: The admin can choose any project from the list of various projects and generate model for those project. Also he can be able to check status of projects.

GENERATE MODEL: The admin can generate the model by selecting the project based on project id.

Preconditions The Admin must be authorized and logged in.

Success End Condition ‘Green color’ Object is displayed to the Admin if a project is completed.

Failed End Condition ‘Red color’ object is displayed to the Admin when project is not completed.

Primary, Secondary Actors Admin.

Trigger This use case is initiated when Admin clicks on ‘Model on the home page’ or he clicks on generate model in the traceability matrix.

DESCRIPTION Step Action1

1a

1b

The Admin clicks Model link to go to the selection of project page

The Admin clicks the generate model button in the traceability matrix

Page 19 of 24

Page 20: SRS Traceability Managment

2

2a

The Admin chooses the project and clicks on Generate Button.

If he clicks on Generate Model, then follow step3.

3The Admin can view the model for that project.

If he clicks on any Object in the model, then follow Step 4.

4a

4b

4c

4d

If the Admin clicks on Project ID Object, then display the whole model.

If the Admin clicks on Requirement ID Object, then display that requirement, design and test cases for that requirement.

If the Admin clicks on Design ID Object, then display design, test cases for that design component.

If the Admin clicks on Test Case ID Object, then display test case.

5 At any stage, Admin can traverse back to Home page for selection and viewing model of some other project.

Use Case ID 7

Use Case name Model Generation by Project Manager

Summary The Project Manager accountable for a project can generate models for his project by choosing the method given below

METHOD 4: Model for Project. The following options will be enabled.

SELECT MODEL: The Project Manager can choose project for which he is accountable and generate model for those project. Also he can be able to check status of his/her project.

GENERATE MODEL: The Project Manager can generate the model by clicking on model link on home page or while he is analyzing the

Page 20 of 24

Page 21: SRS Traceability Managment

traceability matrix.

Preconditions The Project Manager must be authorized and logged in.

Success End Condition ‘Green color’ Object is displayed to the Admin if a project is completed.

Failed End Condition ‘Red color’ object is displayed to the Admin when project is not completed.

Primary, Secondary Actors Project Manager.

Trigger This use case is initiated when Project Manager clicks on ‘Model on the home page’ or he clicks on generate model in the traceability matrix.

DESCRIPTION Step Action

1

1a

1b

The Project Manager clicks Model link to go to the generation of project page

The Project Manager clicks the generate model button in the traceability matrix

2

2a

The Project manager chooses the project he is authorized to view and clicks on Generate Button.

If he clicks on Generate Model, then follow step3.

3The Project Manager can view the model for that project.

If he clicks on any Object in the model, then follow Step 4.

4a

4b

4c

4d

If the Project Manager clicks on Project ID Object, then display the whole model.

If the Project Manager clicks on Requirement ID Object, then display that requirement, design and test cases for that requirement.

If the Project Manager clicks on Design ID Object, then display design, test cases for that design component.

If the Project Manager clicks on Test Case ID Object, then display test case.

5 Project Manager can traverse back to Home page at any time while

Page 21 of 24

Page 22: SRS Traceability Managment

viewing the model.

9. Non Functional Requirements

This section describes in detail all the non-functional requirements

9.1 Usability9.1.1 The system shall allow the users to access the system from the Internet.9.1.2 online help will be available for the system 9.1.3 The end users will be able to able to adapt to the system with a minimum training of 40

hours9.1.4 Key board short cuts will be available for all functions of the system

9.2 Security

9.2.1 Login requirements -

9.2.1.1 The testers and project managers will be provided access to the system after they are registered into the database.

9.2.1.2 While logging in the system for the first time, the testers and project managers will be provided an ID and a password.

9.2.1.3 On logging in, they can set a new password

9.2.2 Password requirements9.2.2.1 Password will be case-sensitive.9.2.2.2 Password must have at least 6 characters,9.2.2.3 Password should be changed if the same password is already taken by other user.

9.2.3 Inactivity timeouts

9.2.3.1 System should timeout when there is no activity for 10 minutes.

9.3 Performance

9.3.1 Response time

9.3.1.1 The response time will be less than 10 seconds for almost all the processes performed in the system.

Page 22 of 24

Page 23: SRS Traceability Managment

9.4 Capacity

9.4.1 Storage

9.4.1.1 Hard disk space –

100 GB – Content

50 GB – Transaction Logs

9.5 Recovery

9.5.1 Recovery time scales

9.5.1.1 The system will be recovered within 12 hours from the down time

9.5.2 Backup Frequencies

9.5.2.1 Details of all the processes carried out by the testers, project manager will be stored in the back-up tapes.

9.5.2.2 All the back-up tapes will be provided to the Project Manager.9.5.2.3 The back-up data will be updated every 10 days.

9.6 Availability

9.6.1 Hours of operation

9.6.1.1 The system will be available on all days 24*7

9.7 Reliability

9.7.1 Mean Time between Failures

9.7.1.1 The mean time between failures for the system will be 90days

9.8 Maintainability

9.8.1 Mean Time to Recovery

9.8.1.1 The Mean Time To Recovery (MTTR) shall not exceed one day.

9.9 Portability

9.9.1 OS requirements

Page 23 of 24

Page 24: SRS Traceability Managment

The system will run on windows XP / Vista / 7 / 8 / 8.1 / 10 and on MAC OS and on LINUX.

9.9.2 Browser requirements

The system will run on Internet Explorer, Internet Edge, Mozilla Firefox, Google Chrome, Safari and UC browser.

9.10 Privacy

9.10.1 Reports cannot be accessed by end users who are not given access to the reports9.10.2 No two users would be able to see their problems.9.10.3 Every problem registered by would have unique id.

Page 24 of 24