Project Business Requirements Document

Business Requirements and Technical Design

Smartbox IT SolutionsSM
PC Solutions for your home, your work, and your life
67 Lincoln Terrace

Bloomfield, CT 06002
xxxxxxxxxxxx

Web Design and Development
Ph: 860.881.3035

Fax: 860.242.0794

sales@smartboxits.com

www.smartboxits.com

DOCUMENT MAINTENANCE LOG
VERSION DATE RESOURCE PURPOSE
1.0 01/22/09 Joshua Flewelling Initial Draft
1.1 01/25/09 Joshua Flewelling Update Technical Design

RESOURCES
Project Manager Joshua Flewelling
Primary Business Contact

Type of Project New Object X Change to Existing Object Both

Page 1

All Rights Reserved. Smartbox IT Solutions® is a Registered Service Mark of Smartbox IT Solutions, LLC. © Copyright 2009 Smartbox IT Solutions, LLC


TABLE OF CONTENTS

Table of Contents ................................................................................................................................................................. 2
NAMING CONVENTIONS AND DEFINITIONS ......................................................................................................................... 3
DOCUMENT PURPOSE .......................................................................................................................................................... 3
PROJECT OBJECTIVE .............................................................................................................................................................. 3
PROJECT DEFINITION ............................................................................................................................................................ 3
CURRENT METHODS ............................................................................................................................................................. 3
FUNCTIONAL REQUIREMENTS .............................................................................................................................................. 4
Business Requirements ................................................................................................................................................... 4
User Interface Requirements .......................................................................................................................................... 8
Quality of Service Requirements ..................................................................................................................................... 8
System Interface Requirements ...................................................................................................................................... 8
Operational Requirements .............................................................................................................................................. 9
BUSINESS PROCESS FLOW .................................................................................................................................................. 10
CONSTRAINTS AND ASSUMPTIONS .................................................................................................................................... 11
Assumptions .................................................................................................................................................................. 11
Risks............................................................................................................................................................................... 11
Open Issues ................................................................................................................................................................... 11
ESTIMATE OF EFFORT ......................................................................................................................................................... 12
TECHNICAL DESIGN ............................................................................................................................................................. 13
Design ............................................................................................................................................................................ 13
Data Design ................................................................................................................................................................... 13
Parameters .................................................................................................................................................................... 13
Business Processing/Rule Design .................................................................................................................................. 13
Critical Event Design ...................................................................................................................................................... 13
Output Design ............................................................................................................................................................... 14
User Interface Design .................................................................................................................................................... 14
System Architecture and Environment ......................................................................................................................... 14
Security Architecture..................................................................................................................................................... 14
TECHNICAL PROCESS FLOW ................................................................................................................................................ 16

Page 2



NAMING CONVENTIONS AND DEFINITIONS
Application The website created for xxxxxxx
Client, You xxxxxxxxxx
Us, We, Company Smartbox IT Solutions

DOCUMENT PURPOSE
The purpose of this document is to describe the business requirements necessary for the implementation of
the Application. All business requirements must be reflected in a version of this document in order to be
included in the final implementation. This document also details the technical design which will include each of
the business requirements.

PROJECT OBJECTIVE
This project will allow the Client to run a website for the purpose of gathering product information and
reviews, while incorporating a social network aspect. The project will allow for the inclusion of advertising
space, gathered and administered by the Client.

PROJECT DEFINITION
The Client identified areas that would have the greatest return and still be reasonable in time to implement
within the given time frame. The features to be created or modified include:

 Adapting some existing code from a previous version of the website as follows:
o User registration
o User login
o Administrator login
o User product uploads
o User review addition
 Incorporating a robust, yet simple-to-use user interface, complete with customized landing pages.
 Allow for the inclusion of advertising spaces on each category page and product page.
 Allow for user-entered reviews and comments on products, as well as addition of ratings and attributes.
 Allow for the creation of private/public groups that focus on a category or specific product.

CURRENT METHODS
The current website at xxxxxxxxxxx is not in use.

Page 3



FUNCTIONAL REQUIREMENTS

Business Requirements

R-1.0 Application Access
R-1.1 The Application shall be usable by all web users regardless of registration status.
R-1.2 The up-time availability of the Application is solely the responsibility of the Client’s
hosting provider, not the Company.
R-1.3 A four-tiered security method will be implemented as follows:
R-1.3.1 Tier I: Super User
1.3.1.1 The Super User will have access to do all updates and modifications to
the Application as the content management system allows.
R-1.3.2 Tier II: Moderator
1.3.2.1 The Moderator is an elevated user, designated only by a Super User.
The Moderator will be able to add or modify specific category or
product detail, remove user posts and ban users. A Moderator must
be a Registered User.
R-1.3.3 Tier III: Registered User
1.3.3.1 The Registered User is any person who has signed up for an account
through the Client. The Registered User shall have access to a
personal and customized page detailing their profile information. The
Registered User will be able to browse all non-restricted areas of the
site, and post comments or attributes to products.
R-1.3.4 Tier IV: User
1.3.4.1 The User is any person who is browsing the site either not logged in,
or any person who has not previously registered. The User will be
able to browse products and categories, but not post comments or
attributes.
R-1.4 Each Registered User will have a personalized profile page and a greeting on the
landing page once they successfully log into the Application.
R-1.4.1 The profile page will include:
1.4.1.1 Name
1.4.1.2 User Name
1.4.1.3 Email
1.4.1.4 Address and Phone (optional)
1.4.1.5 Groups
1.4.1.6 Length of membership
1.4.1.7 Membership status (Super User, Moderator, Registered User, User)
1.4.1.8 Favorite products and categories
1.4.1.9 History of comments on products and categories

Page 4



PC Solutions for your home, your work, and your life Upon registering, the profile page will be created, once the email address
R-1.4.2
has been validated. The Registered User will be able to update their Name,
Email, Address, Phone, Groups, and Favorite Products and categories.
R-1.5 If a Registered User cannot remember either their login name or password, they
will have an opportunity to retrieve or reset the information after validation of their
email address. If the Registered User cannot remember the currently registered
email address, they must email the Client for support.

R-2.0 Landing Page
R-2.1 The Landing Page (LP) is the home page for the Application at xxxxxxxxx.
R-2.2 The LP will contain:
R-2.2.1 The logo for the Client
R-2.2.2 A way for users to login or register
R-2.2.3 Search box
R-2.2.4 Category listing
R-2.2.5 Application navigation
R-2.2.6 Category and product images
R-2.2.7 Top products, Top categories
R-2.2.8 Help
R-2.2.9 Sitemap
R-2.2.10 Copyright, Privacy, and Site Usage information
R-2.3 User Login
R-2.3.1 Users will click on a login link which will open a page where credentials
(username and password) can be entered.
R-2.3.2 Upon successful login, the user will be redirected back to the LP. However,
on the LP and each page within the website, their name will be shown along
with the ability to enter their personal profile page.
R-2.3.3 If a login attempt is unsuccessful, the user will have five (5) opportunities to
enter a correct username/password combination before the account is
locked. If the account is locked, the Application will send an email to the
registered email address for the account containing a link to reset the
password. The account will remain locked until the user follows that link or a
Super User manually unlocks the account.
R-2.4 User Registration
R-2.4.1 Users can become Registered Users by clicking on the link to register.
R-2.4.2 To become a Registered User, they must enter their first and last names,
gender, age group, zip code, and a valid, confirmable email address.
2.4.2.1 The gender, age group, and zip code will be compiled to track the
habits of site usage by demographic.
2.4.2.2 Other information can be collected, as determined by the Client, but
will not be required.
R-2.4.3 Once a user has successfully submitted the registration form, they will
receive an email with a link. Upon clicking the link, their account will be

Page 5



PC Solutions for your home, your work, and your life activated, a personal profile page created (to which they will be
automatically redirected), and a confirmation email sent to them.
R-2.5 Search
R-2.5.1 The search box will return matching words found in the Applications
database, restricted to the category (if chosen) that the user specifies.
R-2.5.2 The results will be ranked based on relevancy.
R-2.5.3 Clicking on a result will open the category or product page.
R-2.5.4 Profiles and private group information will not be searchable through this
function.
R-2.5.5 When a search returns, there will be an option to search within the returned
result set.
R-2.6 Category List
R-2.6.1 The LP will contain a text-listing of current categories.
R-2.6.2 Clicking on a category will reveal sub-categories, if applicable.
R-2.6.3 The user can click on either level to access the category LP.
R-2.7 Navigation
R-2.7.1 The Application navigation is inclusive of the category listing, help link, site
map link, login/register link, search function, and contact information.
R-2.7.2 Navigation within a category will include the ability to filter based on criteria
defined by the Client.
R-2.8 Category and Product Images
R-2.8.1 For each displayed category, a sample image will be shown. Not all
categories will have images featured on the main page. The determination
for which categories and products are shown will be random.
R-2.9 Top Product and Top Category
R-2.9.1 The most viewed products and categories will be ranked and displayed
either textually or with an image on the LP.
R-2.10 Help, Site Map, Legal Information
R-2.10.1 The Help function will include a Frequently Asked Question (FAQ) section,
email links to the Client, and tutorials on site usage.
R-2.10.2 The Site Map will give a text and graphical layout of the site.
R-2.10.3 The Legal information will be standard text, provided by the Company and
modified by the Client as necessary. The Company shall not be responsible
for the content or implications of any posted legal information in the
Application.

R-3.0 Advertising
R-3.1 Data Gathering
R-3.1.1 In order to provide statistical analysis to potential Advertisers, the
Application will store demographics collected via the registration process,
tracked individually for users, and compiled for export to a report format.
R-3.1.2 The Client will make the determination as to whether the information
collected will be used as another revenue stream, or kept private.

Page 6



R-3.2 Advertisement display
R-3.2.1 Advertisers will be able to have a logo displayed at the top of each category
page and product page, user profile pages, and site map. Ads will not be
shown on the LP, the help page, or any legal information page.
R-3.2.2 The ads on the aforementioned pages will be displayed on a rotating basis,
display frequency to be determined by the Client.
R-3.2.3 On the pages, the ads will also be displayed via a vertical banner on the
right-hand side of the page. Other ad locations will be used once the final
Application design has been created and reviewed by the Client. However,
additions of more advertisement space must be approved by the Company,
as extra programming time could extend the length and cost of the project.
R-3.2.4 The Client will arrange the method of, collection of, and determination of
how Advertisers are chosen and the cost of advertisements.
R-3.2.5 A logo upload method will be created, as well as a page for each Register
Advertiser to manage their uploaded logos. Additional functionality on this
page will need to be discussed as it could delay the project and incur
additional costs.

R-4.0 Social Networking
R-4.1 On each product page, Registered Users will be able to add information to products
and product attributes. Each of the additions must be approved by a Moderator or
a Super User first, however.
R-4.2 Comments can be made in a review section of each product. Comments made by
Registered Users who are in a private group will be shown only if the group
moderator allows them to be shown.
R-4.3 Ratings for products will be shown, as well as all public reviews.
R-4.4 Registered Users will be able to create groups, accessible to all invited Registered
Users. The groups, by default, will be private. The groups can add various
categories and products to their comparison list for discussion. The format of their
discussion will be a blog style as well as a visual comparison chart for up to five (5)
products side-by-side.
R-4.5 At this time, there are no plans to make public groups.

R-5.0 Product and Category pages
R-5.1 Products
R-5.1.1 Products will be displayed via a common template.
R-5.1.2 The attributes displayed on each template will be variant, dependent upon
the attributes determined for that specific category-product type.
R-5.1.3 The average rating, number of reviews and a product description will show
on the product page. The product description, specifications, and attributes
can be toggled (made visible or not) on and off.

Page 7



PC Solutions for your home, your work, and your life All social networking tools available for a product will be displayed as
R-5.1.4
designed.
R-5.2 Categories
R-5.2.1 Category pages will display a listing of all related products.
R-5.2.2 Category pages can be filtered based on Client-determined criteria.
R-5.2.3 Category pages will show a thumbnail of the products, along with the
product name, rating, number of reviews, and manufacturer.

User Interface Requirements

R-6.0 User Interface

R-6.1 The User Interface (UI) will contain intuitive navigation and sub-navigation functions.

R-6.2 The UI will contain user registration, user login, and user profile pages.

R-6.3 The UI will contain methods to retrieve and reset passwords.

R-6.4 The UI will contain methods to search for products and categories.

R-6.5 The UI will contain pre-determined areas for advertisement placement.

R-6.6 The UI will present all information clearly, in a professional format.

Quality of Service Requirements

R-7.0 Volume, Capacity, Performance
R-7.1 The Application will be designed to handle numerous simultaneous requests and
database transactions. The load handling capability of the web server is the
responsibility of the hosting provider and the Client.

System Interface Requirements

R-8.0 System Hardware Or 3rd Party Software
R-8.1 All hardware and third-party software is setup and maintained by the Client’s
hosting provider. The Company will provide the custom software, designed to run
on specification as provided by the Client.

R-9.0 Database
R-9.1 The Application will use a MSSQL (SQL Server) database for all transactions. This
database is provided by the Client’s hosting provider.

Page 8



R-10.0 Security
R-10.1 ASP.NET security methods and protocol will be implemented within the Application.
R-10.2 HTA.ACCESS files will be setup and configured by the Company.
R-10.3 FTP Access and Application granted access are the responsibility of the Client.

R-11.0 Network
R-11.1 Not Applicable

R-12.0 Platform Specific

Operational Requirements

R-13.0 Schedule

R-14.0 Support/Help Desk
R-14.1 Client will handle all non-technical support issues.
R-14.2 Company will handle all technical issues related to Application functionality.
R-14.3 Client’s hosting provider will handle all website technical issues.
R-14.4 The Company will determine, at no cost, which party is responsible for the issue at
hand.

Page 9



BUSINESS PROCESS FLOW

Home
(Landing Page)

User Options
Categories Search

SEARCH RESULTS
User Login

Product
Detail

User Register

Database
Custom
Profile Page

Advertiser
Login

N

Super User W E
Login
Admin S
Options
Help Legal Info
Site Map

Contact

Page 10



CONSTRAINTS AND ASSUMPTIONS

Assumptions

R-15.0 Scope
R-15.1 If the project scope deviates from the originally approved version, all scope
differences will be reflected in a Scope Change Document. This document will also
be revised. The change in scope must be approved by all partied in order to be
included in the implemented product. Any change in scope may increase the
project complete date. The Client may also incur additional charges.

R-16.0 Resource Availability
R-16.1 The Client will be readily available for questions.

Risks
No known risks at this time.

Open Issues
No known issues at this time.

Page 11



ESTIMATE OF EFFORT

Please refer to this section instead of the Business Proposal for an estimate. Changes to the estimate will be
reflected here, and may vary from the Business Proposal.

Planning
Gather requirements 6 hours
Assemble Business and Technical Design Documents
Establish Schedule
Programming
Installation of Software 57 hours
Testing
Implementation
Installation of files 5 hours
Post-Implementation System Testing
Training
3 hours
Document Procedures
Demonstrate Application Use
Total: 71 hours

Page 12



TECHNICAL DESIGN

Design

R-17.0 Base Functionality Design
R-17.1 Where possible, all new functions will be created using the 3 layer approach. The
data access will be handled by the Data Access layer. Business rules will be applied
in the Business Rule layer, and user interface information will be handled by the
user interface layer. Each layer will be designed to allow overall portability, e.g. if
the user interface was changed to web from windows, the same business logic
would be invoked from either interface. Serializable objects will be created to move
the data between the layers.

Data Design

R-18.0 Database Design

Parameters

R-19.0 Serializable Objects
R-19.1 Objects will be used to while moving data between the interface, business and
database layers. These objects will be created using and XSD schema. The objects
and the source XML will reside on the web server. The directory will contain the
source XSD schema as well as the created Serializable object. All serialized objects
for this project will be named with the prefix ‘Comp’ to identify them with the
Application function of the business.

Business Processing/Rule Design

To Be Determined

Critical Event Design
Not Applicable

Page 13



Output Design

R-20.0 Report Design/Layout

R-21.0 Message Implementation

User Interface Design

R-22.0 Login

System Architecture and Environment

R-23.0 Application Security Levels
R-23.1 Application security levels will be created from user input. Security group is
predetermined. Users included in a group will be allowed to perform actions within
the application at a different level than the default user.
R-23.2 User
R-23.2.1 This group will have general access to the Application.
R-23.3 Registered User
R-23.3.1 This group will have User access as well as the following functionalities:
23.3.1.1 Post reviews, comments, and attributes
23.3.1.2 Make changes to personal profile
23.3.1.3 Create or join groups
R-23.4 Moderator
R-23.4.1 This group has Registered User access as well as:
23.4.1.1 Approve/Remove Posts
23.4.1.2 Temporarily ban Registered Users
23.4.1.3 Modify product and category detail
R-23.5 Super User
R-23.5.1 This group has Moderator access as well as:
23.5.1.1 Modify all content in the content management system
23.5.1.2 Add or remove Moderators
23.5.1.3 Permanently ban any user
23.5.1.4 Restore any user
23.5.1.5 Add new products or categories
23.5.1.6 Approve/deny product or category suggestions

Security Architecture

Page 14




Page 15



TECHNICAL PROCESS FLOW

Page 16


Project Business Requirements Document

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (20)

Destacado

Destacado (11)

Similar a Project Business Requirements Document

Similar a Project Business Requirements Document (20)

Último

Último (20)

Project Business Requirements Document