Skip to content

Soft Design Specification

cutierobot edited this page Jul 13, 2018 · 26 revisions

SDS - Software Design Specification

Introduction Document Goals

Main Product Features & Capabilities

RevYou will be an aggregated review sites, while many aggregated review sites already exist RevYou will focus on informing the user on what type of person is writing the reviews that they are reading. RevYou hopes that this will give there user more confidence when investing money and time into products. As well as having many fields to search for reviewers by RevYou hopes to implement the standard features of review sites, This includes :

  • User sign up and log in
  • Searching for products
  • Searching for Reviews
  • Adding Reviews

The first iteration of RevYou will only have a limited number of products and will only feature Games, Movies, Books and Boots. Further Iteration hope to expand the product types.

Related Documentation

UML Modeling

(Each diagram should come with a description section, discussing the various considerations leading to the suggested design)

Deployment Diagrams

This deployment diagram will aid in ensuring a majority of the non-functional requirements will be met by ensuring security and privacy. Separating the user account details and the rest of the review storage data into two different databases will make it harder for SQL injection statements to be inserted in the search bar. At the current progress of the project, we are using JSON to replicate the MySQL databases until we reach a stage where we can implement the SQL.

CRC Cards & Class Diagrams

Behaviour: Sequence and/or State Diagrams

The sequence diagram demonstrates how the website will behave with everyday user interactions that will be used on RevYou. The two separate databases can be shown in action with the sequence diagram demonstrating how they will work together on the website. The multi-stepped process of the upvote/ downvote calculation is displayed along with the reputation system.

Persistence

Non-functional Requirements

Ref. # Description
NFR 01 The website shall be secure
NFR 02 The website will protect account holders privacy and security of information
NFR 03 The website will filter out illicit content from reviews
NFR 04 The website will contain 0% illegal content
NFR 05 The websites reviews will be ordered by most upvotes to most downvotes
NFR 06 The website will allow users to remove their review at any time
NFR 07 The website will allow users to create an account
NFR 08 The website will allow users to delete their account at any time
NFR 09 The website will allow customers to search for specific reviews
NFR 10 The website will allow customers to specify the search parameters

Wireframes

search_results add_a_review_page login_page