Software Requirements Specification Notes | CS 430, Study notes of Software Engineering

Download Software Requirements Specification Notes | CS 430 and more Study notes Software Engineering in PDF only on Docsity! S Cheat Check SOFTWARE REQUIREMENT S SPECIFICATION For CS 430 at West Virginia University, Fall 2008 Lee Zaniewski, Kai Ma, Aaron Costa, Chris Cole 2/14/2008 SOFTWARE REQUIREMENTS SPECIFICATION Table of Contents 1.0 Introduction....................................................................................................................4 1.1 Goals and objectives.................................................................................................4 1.2 Statement of scope....................................................................................................4 1.3 Software context.......................................................................................................4 1.4 Major constraints......................................................................................................4 2.0 Usage scenario...............................................................................................................5 2.1 User profiles..............................................................................................................5 2.2 Use-cases...................................................................................................................5 3.0 Data Model and Description..........................................................................................6 3.2 Data objects...............................................................................................................6 4.1 Gather Project Information.......................................................................................7 4.1.1 Processing narrative (PSPEC) for Gather Project Information...........................7 4.1.2 Function Gather Project Information flow diagram...........................................7 4.1.3 Function Gather Project Information interface description...............................7 4.1.4 Performance Issues............................................................................................7 4.1.5 Design Constraints.............................................................................................7 4.2 Compare Documents..................................................................................................7 4.2.1 Processing narrative (PSPEC) for Compare Documents....................................7 4.2.2 Compare Documents flow diagram...................................................................8 ......................................................................................................................................8 4.2.3 Compare Documents interface description........................................................8 4.2.4 Performance Issues............................................................................................8 4.2.5 Design Constraints.............................................................................................8 4.3 View Results..............................................................................................................8 4.3.1 Processing narrative (PSPEC) for View Results................................................8 4.3.2 Function View Results flow diagram................................................................8 ......................................................................................................................................8 4.3.3 Function View Results interface description.....................................................8 4.3.4 Performance Issues.............................................................................................8 4.3.5 Design Constraints.............................................................................................9 4.2 Software Interface Description.................................................................................9 4.2.1 External system interfaces.................................................................................9 4.2.2 Human interface.................................................................................................9 5.0 Behavioral Model and Description..............................................................................10 5.1 Description for software behavior..........................................................................10 5.1.1 Events...............................................................................................................10 5.1.2 States................................................................................................................10 5.2 State Transition Diagrams.......................................................................................11 6.0 Restrictions, Limitations, and Constraints...................................................................12 7.0 Validation Criteria.......................................................................................................13 7.1 Classes of tests........................................................................................................13 7.2 Expected software response....................................................................................13 7.3 Performance bounds................................................................................................13 Page 2 SOFTWARE REQUIREMENTS SPECIFICATION 2.0 Usage scenario This section provides a usage scenario for the software. It contains organized information collected during requirements elicitation into use-cases. 2.1 User profiles Our primary users will be educational instructors. It is likely they have had some previous computer experience. It can also be assumed they have experience with whatever language the document is in. 2.2 Use-cases Page 5 SOFTWARE REQUIREMENTS SPECIFICATION 3.0 Data Model and Description This section describes information domain for the software. 3.1 Context Diagram Figure 1. Context Diagram 3.2 Data objects Query- Parameters of the Cheat Check Analysis Results- Matches, strength of matches Input files- files to be checked locally Parsed Document- An input file that has already been parsed Page 6 SOFTWARE REQUIREMENTS SPECIFICATION 4.0 Functional Model and Description This section contains descriptions of each major software function, along with a data flow diagram. 4.1 Gather Project Information This function takes user input for files or directories to be evaluated as well as a project name and a project type (source code, poem, etc.) User also specifies the run mode (local or global) and various other configurables via the Graphical Interface. 4.1.1 Processing narrative (PSPEC) for Gather Project Information The user selects all project options via the user interface. Once all user options are entered, the selected files are represented in internal data structures and are now ready to be analyzed against other documents. 4.1.2 Function Gather Project Information flow diagram 4.1.3 Function Gather Project Information interface description The interface would consist of a pop-up menu to define project options and a second screen for run time options. The output interface would be a graphical listing of options selected. 4.1.4 Performance Issues Since graphical processing is done in a single main loop, this functionality is not processing intensive. 4.1.5 Design Constraints The user interface should be intuitive as well as follow Human Interface Guidelines (HIG). For example see: http://developer.gnome.org/projects/gup/hig 4.2 Compare Documents The program will take the files from the user input and compare them lexically using tokens. 4.2.1 Processing narrative (PSPEC) for Compare Documents The program compares the files using the tokenized format that the precious function put them in using a specialized algorithm and then returns the results of the comparison. Page 7 SOFTWARE REQUIREMENTS SPECIFICATION 5.0 Behavioral Model and Description A description of the behavior of the software is presented. 5.1 Description for software behavior A detailed description of major events and states is presented in this section. 5.1.1 Events User sets project options User initiates local or global analysis System queries databases System parses documents System Looks for Matches System returns results User exports results 5.1.2 States User Input Prepare List of Project Files Import Project Files Prepare Query Query Repository Load Engine Parse Documents Compare Documents Prepare Results Return Results Display Results Save Results Print Results Page 10 | SOFTWARE REQUIREMENTS SPECIFICATION 5.2 State Transition Diagrams 7 Prepare List of Project Files User Interface Local Engine Import Project Files Prepare Query ) v y A Page 11 SOFTWARE REQUIREMENTS SPECIFICATION 6.0 Restrictions, Limitations, and Constraints There are two primary constraints to our system. The first is time constraints. Due to the nature of our project, and the environment that we are developing this in, we will only have a few months, from February 2008 to May 2008, to finish this project. In addition, we have a limited or non existent budget to develop the project with. This limits the software tools that we will be able to use. Page 12