Software Requirements Specification (SRS) Document for RSS with TTS Version 1.0 approved Prepared by Mark Carroll Matt Ferguson CS490: Senior Project 10/7/2011 Software Requirements Specification for RSS with TTS Page 2 Sign-offs I agree that this document represents our best understanding of the requirements for this project today and the system described will satisfy our needs. I agree to make future changes in this baseline through the projectâs defined change process. I realize that approved changes might require us to negotiate the cost, resources, and schedule commitments for this project. Name Title Signature Date Name Title Signature Date Name Title Signature Date Name Title Signature Date CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 3 Contents Sign-offs 2 Revision History 5 1 Introduction 6 1.1 Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2 Document Conventions . . . . . . . . . . . . . . . . . . . . . . . 6 1.3 Intended Audience and Reading Suggestions . . . . . . . . . . . . 6 1.4 Project Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.5 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2 Overall Description 6 2.1 Product Perspective . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.2 Product Features . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.3 User Classes and Characteristics . . . . . . . . . . . . . . . . . . 7 2.4 Operating Environment . . . . . . . . . . . . . . . . . . . . . . . 7 2.5 Design and Implementation Constraints . . . . . . . . . . . . . . 7 2.6 User Documentation . . . . . . . . . . . . . . . . . . . . . . . . 7 2.7 Assumptions and Dependencies . . . . . . . . . . . . . . . . . . 7 3 System Features 8 3.1 Text to speech . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.1.1 Description and Priority . . . . . . . . . . . . . . . . . . 8 3.1.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 8 3.1.3 Functional Requirements . . . . . . . . . . . . . . . . . . 8 3.2 Easy to use, intuitive interface . . . . . . . . . . . . . . . . . . . 8 3.2.1 Description and Priority . . . . . . . . . . . . . . . . . . 8 3.2.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 8 3.2.3 Functional Requirements . . . . . . . . . . . . . . . . . . 8 3.3 Built-in feed list . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.3.1 Description and Priority . . . . . . . . . . . . . . . . . . 9 3.3.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 9 3.3.3 Functional Requirements . . . . . . . . . . . . . . . . . . 9 3.4 Built-in browser . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.4.1 Description and Priority . . . . . . . . . . . . . . . . . . 9 3.4.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 9 3.4.3 Functional Requirements . . . . . . . . . . . . . . . . . . 9 3.5 Sharing of articles . . . . . . . . . . . . . . . . . . . . . . . . . . 9 CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 4 3.5.1 Description and Priority . . . . . . . . . . . . . . . . . . 9 3.5.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 10 3.5.3 Functional Requirements . . . . . . . . . . . . . . . . . . 10 3.6 Configurable synchronization . . . . . . . . . . . . . . . . . . . . 10 3.6.1 Description and Priority . . . . . . . . . . . . . . . . . . 10 3.6.2 Stimulus/Response Sequences . . . . . . . . . . . . . . . 10 3.6.3 Functional Requirements . . . . . . . . . . . . . . . . . . 10 4 External Interface Requirements 10 4.1 User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.2 Hardware Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.3 Software Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.4 Communications Interfaces . . . . . . . . . . . . . . . . . . . . . 11 5 Other Nonfunctional Requirements 11 5.1 Performance Requirements . . . . . . . . . . . . . . . . . . . . . 11 5.2 Safety Requirements . . . . . . . . . . . . . . . . . . . . . . . . 11 5.3 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . 11 5.4 Software Quality Attributes . . . . . . . . . . . . . . . . . . . . . 11 Appendices 12 A Glossary 12 B Analysis Models 12 C Issues List 12 CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 5 Revision History Name Date Reason For Changes Version Mark Carroll 10/7/2011 Initial release 1.0 CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 6 1 Introduction 1.1 Purpose This document covers RSS with TTS, along with all currently planned features, up to its initial release. 1.2 Document Conventions Priorities for high-level requirements are assumed to be inherited by detailed re- quirements. 1.3 Intended Audience and Reading Suggestions This document is intended for developers and project stakeholders. Suggestions for reading include reading in chronological order. 1.4 Project Scope As stated in the vision and scope document, the scope of this project is a full featured RSS reader with text-to-speech functionality. The project will be divided into two development periods, with one culminating in a demo of one major feature and the second in a full release candidate. 1.5 References This document does not reference any external resources. 2 Overall Description 2.1 Product Perspective RSS with TTS is a new, self-contained product. It currently stands as the only proposed Android RSS reader that implements text-to-speech. 2.2 Product Features There are several planned features for RSS with TTS. The most important of these is text-to-speech functionality, which will be performed using native Android li- braries available for all devices using software version 1.6 and higher. Other fea- tures include: providing an easy to use, intuitive interface that includes RSS image CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 7 parsing and multiple views, providing a built-in, sortable feed list, providing built- in browser support, as well as enabling the sharing of articles and allowing for configurable auto-synchronization. 2.3 User Classes and Characteristics Two user classes are anticipated: those who are familiar with RSS and those with no RSS experience. Users who are familiar with RSS will find no issue with the configuration of the application, while those with no RSS experience will be pro- vided assistance via included documentation. Users familiar with RSS will be favored, therefore requirements critical to those without experience will be less important to satisfy. 2.4 Operating Environment The software will operate on devices supporting Android version 1.6 and above. For proper text-to-speech functionality, these devices will also need the TTS library installed. The application, upon initialization, will check for these libraries and provide the user with installation options. 2.5 Design and Implementation Constraints The primary constraint will be a 32 week period of research and development, upon which a release candidate will be made available. 2.6 User Documentation A user manual will be provided with the application. This manual will describe the functionality of RSS as well as how to properly operate the application. 2.7 Assumptions and Dependencies It is assumed that text to speech can be implemented in the manner described in the product description. CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 8 3 System Features 3.1 Text to speech 3.1.1 Description and Priority This feature will provide audio for the text included within individual RSS feeds. It is of high priority. 3.1.2 Stimulus/Response Sequences User will activate a button to load on-screen text into TTS engine and initiate audio playback. 3.1.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher with TTS libraries installed. If TTS libraries are not installed, provide prompt and ability to install from application. REQ-2: User must have at least one RSS feed configured and one article selected. If no feeds are configured, provide prompt and ability to do so. 3.2 Easy to use, intuitive interface 3.2.1 Description and Priority This feature will provide the overall interface for the application. It is of high priority. 3.2.2 Stimulus/Response Sequences User will have multiple available interactions, such as configuring feeds, view mode, and other options. 3.2.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher. CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 9 3.3 Built-in feed list 3.3.1 Description and Priority This feature will provide the user with a collection of pre-defined RSS feeds. It is of high priority. 3.3.2 Stimulus/Response Sequences User will be provided with a selectable list of RSS feeds. Upon selection, feeds will be set to appear in main application interface. 3.3.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher. 3.4 Built-in browser 3.4.1 Description and Priority This feature will provide the user with the ability to view full article content within application. It is of medium priority. 3.4.2 Stimulus/Response Sequences User will activate a button to load corresponding full article within application. Application will create a customized WebView interface to present requested arti- cle. 3.4.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher. 3.5 Sharing of articles 3.5.1 Description and Priority This feature will provide the ability to share articles via e-mail and MMS. It is of low priority. CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 10 3.5.2 Stimulus/Response Sequences User will activate a button to share corresponding article link via default email or messaging application. 3.5.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher. REQ-2: User may need to provide contact-list permission on install. 3.6 Configurable synchronization 3.6.1 Description and Priority This feature will provide the ability to configure when the application checks for updates to RSS links. It is of low priority. 3.6.2 Stimulus/Response Sequences User will activate option within application settings panel. 3.6.3 Functional Requirements REQ-1: User must be running Android version 1.6 or higher. 4 External Interface Requirements 4.1 User Interfaces The user interface will be a primary factor in development of this project. It will consist of a streamlined set of views that provide consistent button and information location. 4.2 Hardware Interfaces The application will rely on wireless hardware, both WLAN and/or mobile data, in order to download the content of selected RSS feeds. The application will only support Android devices capable of running version 1.6 and above. CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 11 4.3 Software Interfaces The application will rely on the use of at least one SQLite database to store and access predefined and user-provided RSS feed content. The application will also require an Android text-to-speech library to be installed in order to process play- back requests. This library requires, at minimum, Android software version 1.6. 4.4 Communications Interfaces Standard HTTP communication will be required in order to load RSS feed content and subsequent full article links. 5 Other Nonfunctional Requirements 5.1 Performance Requirements The application will need to provide a responsive interface. There should be min- imal delay, other than that caused by connectivity issues, in retrieving RSS feed content and associated detail. 5.2 Safety Requirements There are no safety requirements associated with this application. 5.3 Security Requirements There are no security requirements associated with this application. 5.4 Software Quality Attributes The software is planned to be robust and complete, in order to attract new users, while also providing an intuitive and usable interface that is free of clutter and easy to use. CS 490: Senior Project I Fall 2011 Software Requirements Specification for RSS with TTS Page 12 Appendices A Glossary B Analysis Models C Issues List CS 490: Senior Project I Fall 2011 Sign-offs Revision History Introduction Purpose Document Conventions Intended Audience and Reading Suggestions Project Scope References Overall Description Product Perspective Product Features User Classes and Characteristics Operating Environment Design and Implementation Constraints User Documentation Assumptions and Dependencies System Features Text to speech Description and Priority Stimulus/Response Sequences Functional Requirements Easy to use, intuitive interface Description and Priority Stimulus/Response Sequences Functional Requirements Built-in feed list Description and Priority Stimulus/Response Sequences Functional Requirements Built-in browser Description and Priority Stimulus/Response Sequences Functional Requirements Sharing of articles Description and Priority Stimulus/Response Sequences Functional Requirements Configurable synchronization Description and Priority Stimulus/Response Sequences Functional Requirements External Interface Requirements User Interfaces Hardware Interfaces Software Interfaces Communications Interfaces Other Nonfunctional Requirements Performance Requirements Safety Requirements Security Requirements Software Quality Attributes Appendices Glossary Analysis Models Issues List