SRS Outline0517

Embed Size (px)

Citation preview

  • 7/30/2019 SRS Outline0517

    1/17

    Group 3

    Project IQ Social Networking Component

    Systems Requirements Specification

    Version 1.1

    April 28, 2009

    Copyright 2009 by , and

  • 7/30/2019 SRS Outline0517

    2/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    About This Document

    Purpose of thisDocument

    The Systems Requirements Specification (SRS) is designed to express thebehavioral, performance, and development requirements of this product andserves as the fundamental requirements document for the development of

    the product. The Systems Requirements Specification includes adescription of every input into the system, every output from the system andall functions performed by the system in response to input or in support ofan output. The SRS meets IEEE830 standards and is the exclusiverequirements document to be used in development; all design and testingchoices must be compatible with this document.

    DocumentPrepared for

    Ohio State CSE 772

    IntendedAudience

    Banks in possession of foreclosed property

    Date ofPublication

    Last saved: May 9, 2009This printing: December 30, 2012

    Page Count pages

    DocumentLocation

    Prepared From SRS_Outline.doc

    AssociatedProcedures

    CSE772, Information Systems Capstone, SP09

    Prepared by Tyler Scheerens, Steve Wohlwend

    [email protected], [email protected]

    CopyrightNotice

    Permission to make digital or hard copies of all of this work for personal orclassroom use is granted without fee provided that copies are not made ordistributed for commercial advantage and that copies bear this notice andthe full citation on the first page. Abstracting with credit is permitted. Tocopy otherwise, to republish, to post on servers, or to redistribute to lists,requires prior specific permission and/or a fee. Request permission torepublish from Tyler Scheerens .

    ii Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    3/17

    Product Requirements Document CSE 772Revision History Project IQ Social Networking Component

    Revision History

    Date Revision Description Author

    4/23/2009 1.0 Initial Project DescriptionSections: 2.1.4, 2.1.5, 2.2

    Tyler Scheerens

    4/28/2009 1.1 Sections: 2.1.1, 2.1.2, 2.1.3, 2.2 Tyler Scheerens

    5/09/2009 1.2 Sections: 1.1, 1.2, 2.3, 2.4 Steve Wohlwend

    wohlwend Proprietary and Confidential iii

  • 7/30/2019 SRS Outline0517

    4/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    Table of Contents

    1. INTRODUCTION................................................................................................................................. ....1

    1.1. PURPOSE.......................................................................................................................................... .......1

    1.2. SCOPE.....................................................................................................................................................1

    1.3. REFERENCES.............................................................................................................................................1

    1.4. STANDARDS.................................................................................................................................... .........1

    1.5. DEFINITIONS..............................................................................................................................................1

    2. OVERALL DESCRIPTION......................................................................................................................1

    2.1. PROJECT ABSTRACT....................................................................................................................................1

    2.1.1. Project Scope.....................................................................................................................................1

    2.1.2. Background........................................................................................................................................1

    2.1.3. System Purpose.................................................................................................................................12.1.4. System Mission ................................................................................................................................2

    2.1.5. System Functions / Responsibilities .................................................................................................2

    2.2. FUNCTIONAL OBJECTIVES...................................................................................................................... .......2

    2.3. SYSTEM CONSTRAINTS ................................................................................................................ ...............2

    2.3.1. User Interface Constraints ................................................................................................................2

    2.3.2. Hardware Constraints........................................................................................................................2

    2.3.3. Software Constraints..........................................................................................................................3

    2.3.4. Communications Constraints.............................................................................................................3

    2.3.5. Data Management Constraints..........................................................................................................3

    2.3.6. Operational Constraints.....................................................................................................................3

    2.3.7. Site Adaptation Constraints.............................................................................................................. .3

    2.3.8. Design Standards Compliance...........................................................................................................3

    2.4. OTHER CONSTRAINTS..................................................................................................................................3

    3. SYSTEM EVENTS AND DATA FLOWS.................................................................................................4

    3.1. EVENT TABLE............................................................................................................................................4

    3.2. CONTEXT DIAGRAM.....................................................................................................................................4

    3.3. PRODUCT FUNCTIONS - SYSTEM ACTIVITIES ....................................................................................................63.4. USER CHARACTERISTICS..............................................................................................................................6

    4. SPECIFIC REQUIREMENTS..................................................................................................................1

    4.1. USE CASE DIAGRAM - ORGANIZEDBYSUBSYSTEM..............................................................................................1

    4.2. USE CASES..............................................................................................................................................2

    4.2.1. Use Case Scenario .....................................................................................................................2

    iv Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    5/17

    Product Requirements Document CSE 772Revision History Project IQ Social Networking Component

    4.2.2. Use Case Prototype....................................................................................................................3

    4.2.3. Use Case Object Interaction Diagram ...................................................................................... .3

    5. VALIDATED OBJECT MODEL...............................................................................................................4

    5.1. CLASS DIAGRAM................................................................................................................................. .......4

    5.2. CLASS SPECIFICATIONS...............................................................................................................................5

    wohlwend Proprietary and Confidential v

  • 7/30/2019 SRS Outline0517

    6/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    1. Introduction

    1.1. Purpose

    The Project IQ Social Networking Component provides the functionality of a message board, usercomment system, and a means of uploading appraisals.

    1.2. Scope

    The Social Networking component integrates the open source Yet Another Forum messageboard code. It also involves modification to the Property IQ master page to integrate a user loginsystem. It includes a nested page for each property that lists forum threads about that particularproperty. It finally includes an appraisal hosting and uploading system.

    1.3. References

    This is a complete list of all documents referenced elsewhere in this document.

    1. Systems Analysis and Design in a Changing World , Satzinger, Burd, Jackson, 3rd edition.

    2. The Object Oriented Approach Concepts, System Development and Modeling with UML,Satzinger, Orvik, 2nd edition.

    1.4. Standards

    This is a complete list of all standards used in this document.

    1. IEEE 830-1993 The content and qualities of a good Systems Requirements Specification(SRS) are described and several sample SRS outlines are presented. This recommendedpractice is aimed at specifying requirements of software to be developed but also can beapplied to assist in the selection of in-house and commercial software products.

    1.5. Definitions

    This section contains a list of definitions for organizational specific words that are not universal.

    GUI Graphical User Interface

    WSID Workstation Identification Number

    DB - Database

    wohlwend Proprietary and Confidential 1

  • 7/30/2019 SRS Outline0517

    7/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    2. Overall Description

    2.1. Project Abstract

    Project Name: Project IQ Social Networking Component

    Authors: Steve Wohlwend, Tyler Scheerens, Erdem Myalcin, Kim

    Date: 9 May 2009

    2.1.1. Project Scope

    Property IQ will be a real estate property and foreclose tool giving users access tostatistical data, maps and pictures of all real estate properties in an area, tools to helpmodel past and future values of the property, and a social networking aspect that allows

    users to communicate with each on a dedicated forum, or post information on specificlisted properties. This document deals with the social networking component.

    2.1.2. Background

    A recent credit crisis in the United States has led to a significant increase in the number ofdistressed and foreclosed homes. The system being developed will provide a multi-purpose tool for handling a variety of tasks associated with these properties.

    One component of the mashup will show static information on all properties in an area.Things like recent selling price, number of bedrooms, and other commonly availableinformation.

    A second component will gather all GIS data and pictures associated with a home,including providing a tool to locate other properties sold in the area.

    The third component will provide trends data on the future price of the home based oninformation gathered by the statistical data group and an in house developed formula.

    The fourth group will provide a social networking aspect to the website, enabling users topost on real esate-related message boards, or comment and attach information on specificproperties.

    2.1.3. System Purpose

    Who Mortgage brokers, real estate agents, prospective home buyers Where The system will be web-based and accessible to all users.

    What Scope:

    o The system will be responsible for providing up to date

    information on all properties in an area and allow users to

    communicate on general topics or specific properties.

    o The system will not allow users to buy and sell properties on the

    site.

    Why A credit crisis in the United States has led to a high number

    wohlwend Proprietary and Confidential 1

  • 7/30/2019 SRS Outline0517

    8/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    distressed and foreclosed properties.

    2.1.4. System Mission

    Build a social networking component for a real estate and foreclosure mashup that willallow user interaction with the real estate system in the form of a user discussion board, a

    property listing service, and the ability for users to post topics dedicated to specificproperties where information like pictures and appraisals about that property can beposted.

    2.1.5. System Functions / Responsibilities

    1. Discussion board available to mashup users to discuss relevant real estate andforeclosure topics.

    2. Listing resource where users can list or begin discussions about specific properties. Thisaspect will also list information available from other components of the mashup that arerelevant to the specific property (hard data, maps, and price models).

    3. The ability to attach appraisal information to a specific property. That appraisalinformation will be shared with the trends component of the mashup to make better priceprojections on a given property.

    4. Develop a simple and efficient search feature to find topics and information on specificproperties.

    5. Develop and manage a user registration and login system for the web site.

    2.2. Functional Objectives

    1. The system shall provide a user message board, allowing users to post realestate related discussion topics on the site.

    2. The system shall provide the ability for users to post topics on specific properties,allowing users to request information on said property, post images and otherrelated data, and discuss the property with other users.

    3. The system shall provide the ability for users to register and login before they areallowed to interact with the social networking aspect of the web site.

    4. The system shall provide hosting for and the ability to upload appraisaldocuments for appropriate users.

    2.3. System Constraints

    2.3.1. User Interface Constraints

    Using this system is fairly simple and intuitive. A user familiar with basic browsernavigation skills should be able to understand all functionality provided by the system.

    2.3.2. Hardware Constraints

    The system should work on most home desktop and laptop computers.

    2 Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    9/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    2.3.3. Software Constraints

    The system is designed to run on Firefox 3 and Internet Explorer 7.

    2.3.4. Communications Constraints

    System must have access to the included database. Other components of the Property

    IQ system may require access to certain data and web services; refer to thosecomponents' documentation for details.

    2.3.5. Data Management Constraints

    System shall be able to interface with other components according to their specifications.

    2.3.6. Operational Constraints

    The system is limited by its operating server in terms of the maximum number of users it

    can support at a given time.

    2.3.7. Site Adaptation Constraints

    The component will be adapted to the overarching system at the conclusion of thesystem creation.

    2.3.8. Design Standards Compliance

    The system shall be implemented in ASP.

    2.4. Other Constraints

    None.

    wohlwend Proprietary and Confidential 3

  • 7/30/2019 SRS Outline0517

    10/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    3. System Events and Data Flows

    3.1. Event TableNote that unmodified message board actions are omitted and oversimplified. Checkyetanotherforum.net for detail about those operations.

    Event Trigger Source Activity Response Destination

    User Login Username andPassword

    User Profile tablelookup

    Cookieprovided to

    user

    User datadisplayed onfront page

    AppraisalUpload

    PDF file User File placed onwebsite

    Link placed inappraisals tab

    New appraisalfile listed andavailable fordownload

    Topic Creation Post data User New topiccreated indatabase

    Topic dataadded to forum

    page

    Topic datadisplayed

    Forum Post Post data User New postadded to topic

    in database

    Post dataadded to topic

    page

    Post datadisplayed

    3.2. Context Diagram

    4 Proprietary and Confidential wohlwend

    PropertyIQ

    User

    Master page

    User protable

    Profile data

    Logininformation

    Profile dataLogininformation

  • 7/30/2019 SRS Outline0517

    11/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    wohlwend Proprietary and Confidential 5

    PropertyIQ

    User

    Forum page

    Messageboarddatabase

    Post page

    Postinformation

    Postinformation

    Post data

    PropertyIQ

    User

    Forum topicpage

    Messageboarddatabase

    Topic page

    Topicinformation

    Topicinformation

    Topic data

    PropertyIQ

    User

    Appraisal page

    Appraisal table

    Hosted fileinformation

    PDF file

    Link to hostedfile

    Appraisal PDF

  • 7/30/2019 SRS Outline0517

    12/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    3.3. Product Functions - System Activities

    This subsection of the SRS provides a summary of the major processes that the software willperform, which includes the system tasks and features from the Product Requirements document

    and Project Charter.2.2.1 Message Board

    The system provides a message board for users to post real estate discussions.

    2.2.2 Topic Posts Tied to Properties

    Topics may be linked to a particular property, causing that propertys Discussion tab tolist it among its relevant topics.

    2.2.3 Registration and Login

    The small login menu has been relocated to the website master page. Users may log infrom the front page rather than going to the forum first.

    2.2.4 Appraisal Upload

    Properties have a tab that displays posted appraisals of that property. Owners mayupload additional appraisals.

    3.4. User Characteristics

    Property IQ users consist of the following:

    Managers who wish to perform system administration functions as well as serve asproperty holders.

    Property holders who wish to claim properties, post appraisals on them, serve ascontacts for property purchases, and serve as consumers.

    Consumers who wish to browse property listings and post questions and answers on the

    forum topics.

    6 Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    13/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    4. Specific Requirements

    This section of the SRS contains all the system requirements to a level of detail sufficient to enabledesigners to design a system that satisfies those requirements. Testers can use this section to test that

    the system satisfies those requirements and technical writers can create the necessary supportdocumentation for operations and maintenance. Note: Use Cases are in priority order.

    4.1. Use Case Diagram - organized by subsystem

    wohlwend Proprietary and Confidential 1

  • 7/30/2019 SRS Outline0517

    14/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    4.2. Use Cases

    Use Cases are requirements from the Client translated into unambiguous language. A Use Casemay have multiple inputs or outputs as part of the same functional flow. A Use Case without anyinput or output is not valid. The detailed requirements of a Use Case tend to be extensive. Forthis reason, it is recommended that careful consideration be given to organizing the requirements

    in a manner optimal for understanding. Subcases are identical to use cases except where noted.This section provides descriptions of all the use cases devised for this system.

    Each use case description provides the following information:

    4.2.1. Use Case Scenario

    Purpose A brief description of what the user is trying to accomplish.

    Actor A person or external system outside the scope of the system

    that triggers step one of the Detailed Description.

    Input Data A list of all external data needed for the use case to beperformed.

    Output Data A list of all data produced by the use case execution.

    Invariants A condition which is maintained throughout the use case. Thissection is used to highlight assumptions made for the sake ofthe use case.

    Pre-conditions Conditions which must hold for the use case to be applicable.It is assumed that these conditions are true prior to the

    beginning of the use case, and will not be true when the usecase completes.

    Post-conditions Conditions which are guaranteed to hold after completion ofthe use case.

    Basic Flow: A single, error-free path, which may contain subflows,calculations, logical structures, etc.

    Alternative Flow(s): All exception and error cases, including where/how they weretriggered

    Extension Points: and cases and where they were

    referenced

    Business Rules: The rationale for this case, also explains exceptions and errors

    Notes Any other relevant information not included in the abovesections.

    2 Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    15/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    4.2.2. Use Case Prototype

    [Complete set of simple discovery prototypes showing all user interaction for basic andalternate flows.]

    4.2.3. Use Case Object Interaction Diagram

    [Sequence or Collaboration diagram showing all participating classes and messages thattrigger response for basic and alternate flows.]

    wohlwend Proprietary and Confidential 3

  • 7/30/2019 SRS Outline0517

    16/17

    CSE 772 Systems Requirements SpecificationProject IQ Social Networking Component Introduction

    5. Validated Object Model

    The Validated Object Model is a visual representation of the idealized problem domain. The consistencybetween the Sequence Diagrams and the Object model validates the requirements.

    5.1. Class Diagram

    The Class diagram shows the structural scope-of control- entities and relationships in theproblem domain of the Object Model.

    4 Proprietary and Confidential wohlwend

  • 7/30/2019 SRS Outline0517

    17/17

    Systems Requirements Specification CSE 772Introduction Project IQ Social Networking Component

    5.2. Class Specifications

    Class Specifications are the prose detail necessary to elaborate the definitions of eachclass attribute and algorithm of each class operation.

    Class

    Parent

    Description

    Attributes

    Methods

    wohlwend Proprietary and Confidential 5