You are on page 1of 10

[ CSC318 SOFTWARE ENGINEERING PRINCIPLES ]

Onsite HVACR Software


Design Documentation
Development and Requirements
Team B:
Nicholas Diley Project Manager
David Small Programming Lead
Devon Thomsen Programming Lead

Contained within this document are the developmental strategies, scope and requirements
being fulfilled by Team B for the CSC318 Software Engineering Principles class for Onsite
HVACR.

TABLE OF CONTENTS

Contents
ABOUT THE PROJECT.................................................................................................................2
PURPOSE........................................................................................................................................2
SCOPE.............................................................................................................................................3
CLIENT IDENTIFICATION...........................................................................................................3
REQUIREMENTS..........................................................................................................................4
CONSTRAINTS..............................................................................................................................7
ESTIMATED TIMELINE...............................................................................................................8

ABOUT THE PROJECT


Developed and to be used by the company Onsite HVACR and their customer base, the software
entailed is going to be a static database that will be used to house the information regarding the
following:

Company Information
Company Policies
Item Pricing
o Heating and Air
o Plumbing (Potentially)
Warranty Information
Plan Information
Contact Information

It will be completed by one team within the CSC318 Software Engineering Principles class in
the Spring Semester, which began 1/12/2015 and will end on 5/2/2015.

PURPOSE
This software will be developed for the standard Windows Environment, preferably for
compatibility between Windows 7 and 8 System, and will be distributed physically through flash
drives throughout various homes and commercial properties with key information about the
systems that are inside, or to be downloaded from the Onsite HVACR website.
This software will be executed from various computer systems and will have a comprehensible
GUI that the customers will be able to use to navigate through various menus. These menus are
expected to be:

Heating & Air

Plumbing

Pricing & Plans

Contact Information

For marketing usage, this software will possess key pricing information, and information
regarding systems within a commercial or residential property, combined with warranty
information and methods of replacement or repair.
This software will proceed to be distributed across the customer base across the extents of the
Southern Indiana residential area, or throughout the Northern Kentucky commercial areas,
extending further to Tennessee.

SCOPE
This software will be developed for the WINDOWS 7/8.1 Environment, capable to be executed
from a standalone program to view and communicate with the database within. Should all goals
be met and with the proper skill set and hours maintained, further work will be made to make
other compatible software for the MACINTOSH or LINUX distributed systems.
Should further work be necessary, and should the team possess the time and skill set, further
maintenance will be made on the WINDOWS environment, as newer versions with updated price
listings and plan/warranty information should be released in a timely manner.
In Summary:
The primary goal is to create a working DATABASE for the WINDOWS environment.
Stretch goal could potentially offer support for MACINTOSH or LINUX environments with
standalone versions (yet WINDOWS executables may work within those environments
regardless).
Mobile Application has been brought up in theory, however the time constraints and skill
constraints would not allow such development.

CLIENT IDENTIFICATION
David Disponett - Owner of Onsite HVACR
Email: one8upfan@aol.com
Phone: (502)773-4827
Regina Disponett Office Manager of Onsite HVACR
Email: regina@onsiteplumbing.com
Phone: 812-945-2277
Donnie Diley Superintendent Onsite HVAC
3

Email: Donnie.onsitehvacr@gmail.com
Phone: 502-295-1065
Onsite Plumbing, Heating & Air
Address: 3013 Blackiston Mill Rd, Clarksville, IN 47129
Phone:(812) 945-2277
Nicholas Diley, the Project Manager, has been an acquaintance of David Disponett for
approximately 3 years and had done some IT Work for his company.

REQUIREMENTS
Contained below are the main requirements of the Software Development Project:

Develop GUI Application for Onsite HVACR (Primary Scope)


o Contain Detailed information of:
Plumbing System Maintenance and Installation
Heating and Air System Maintenance and Installation
Plan and Warranty Information
o Product Calculator
Price and Plan Estimates
Warranty Information
o Business Information
Mission Statement
Contact Information
Stretch Goals
o Develop Software for use on Apple Products/Desktops
o Develop Software as a Mobile Application

The software alone is to be a static database that can be referenced back to or include
information regarding various Heating & Air Systems and Plumbing Systems.
Potentially it will be pull information from an external file or spreadsheet for easy access or
iterations of the software itself. Current methods in production could be an SQL database, Excel
Spreadsheet Data, or other forms of documentation.
The GUI will be easy to comprehend and will contain information regarding practical use and
how to navigate the screens.
The software will run as a standalone executable, and will not require any outside programs to
function. It will also work offline, so should it be utilized in a computer without a network
connection, it will function properly due to a static database.
4

The program is looking to be coded in C#, as our team has experience with database systems and
GUI development using C# in particular. This may be subject to change as we continue with
development, and find an easier solution.
All product information within this database will be created depending on the spreadsheets and
marketing data that has been sent to us. Within these documents would be the NAME and
DESCRIPTION of the various products, how powerful they would be in certain properties, and
what is needed to maintain such systems. The database will include information such as:

Product Name
Product Model Number
AHRI (Air-Conditioning, Heating, and Refrigeration Institute) Certificate Number
Product Dimensions
Product Input-Output
Product Description
Product Price
Product Plan Listing
Product Warranty Information
Directory link to find the system in more detail
Product Comparison with key factors

An example of one of the sheets can be found below:

We understand that information about these systems would not be known or understood by the
general audience/customer, so it is within our scope to simplify the interface process and include
methods that would allow the standard user to read information and translations for key words or
terms within this industry.
Information will also be supplied in the sense of potential house sizes versus the power of the
system provided, and a general chart of when to consider a stronger system or maintenance
where necessary.
Pricing guides for the products will be included within the general description of the individual
systems, including a comparison price of RETAILER versus MARKET VALUE and the prices
of plans and warranties with individual systems.
The pricing will be altered for view depending on COMMERCIAL versus RESIDENTIAL
properties, and will have varying plans for both.
6

Within the software will potentially be a PRICING GUIDE and PRICE CALCULATOR that will
estimate prices, processing and tax information to come up with an estimated price of install for
RESIDENTIAL or COMMERICAL properties.
File size has not been specified, however we estimate the final product to be 100-125 MB.
Should it be larger, methods of condensing the file size may be taken, or will not be taken too
much into account for the software may be distributed manually amongst the various households
in flash memory units.
Finally, within the software will be company information, with general contact information,
inquiries about pricing and plans, along with a short biography of the owner and the company in
business. Potential opportunities may arise in embedding a short video about the Company as
well, but it is up to limitations with the file size above, and developmental processes undertaken
by the software development team. This software must also be portable to be able to be used on
outside machines and computer systems.

CONSTRAINTS
The team creating the software has not undertaken a project as large as this, as it will potentially
be one of the largest projects being undertaken by the individuals as a whole. The levels of
education vary amongst the team members, but should still be able to work on the software in a
timely and productive manner.
File size is a large constraint as the development of this software could prove very memory
intensive, or could be very large in final product size. Estimated file size should be within the
100-125 MB size, but could very well end larger depending on the quality of the program,
should there be no overflowing members of data, and providing that the team follows proper
coding standards.
Time is a large factor to be taken into account, but the team is fully prepared and will be working
at least 3-6 hours minimum per week on the developmental stages. Should there be more work to
be done, more time will be taken as necessary, and once development is finished, the debugging
and testing phases begin with roughly the same amount of time taken.
Resources are not to be taken into too much consideration. Each team member has the software
and hardware capabilities to participate in the development process.

ESTIMATED TIMELINE
Below is the estimated order of events of which the project will be undertaken.

Complete the Pre-Assessment Phase of Development


o Research of HVACR Terms and Vocabulary [ DONE ]
o Receive Introductory Spreadsheet Data [ DONE ]
o Receive Introductory Product Information [ DONE ]
Introductory Stages of GUI Development
o Decide on Coding Standard [ IN PROGRESS REST TBA ]
o Begin on Introductory Development
Screen Navigation
Product View Preparation
Collaboration and Use
o Prepare for File & Spreadsheet Import
Create Spreadsheet/External File Data
o Format for use with GUI
o Arrange Data for Simplicity Purpose
Pricing & Product Information
o Potential for reinstallation/reimplementation of various files
Implement Spreadsheet/External File Data within GUI
o Ensure compatibility issues
o Debug where necessary
o Plug in information into GUI from Spreadsheet
o Implement other information Normally
QA Test Navigation and File Access
o Initial Client access to software
o Receive software assessment from Client
o Potential for reimplementation of various files
o Test on various WINDOWS systems
o Next version to be sent to Client for use
o Receive software assessment from Client
Final Stages for Pricing and GUI Files
o Receive any Final Price Changes
o Receive any Final Spreadsheet Data
o Receive any Final Product Information
o Implement any FINAL changes to software
Send Final Product to Client
o Keep Newest version on hand
o Send Newest version to Client
o Receive FINAL software assessment
9