Software Clicker System
Software Version Description
Draft #1
_________________________
John Cronkite
_________________________
Dustin Masters
_________________________
Scott Giegel
COSC 4303 - Software Engineering II
DRAFT # 1
1
1. Scope.
1.1 Identification.
This document describes the first public version of The Software Clicker System(SCS). This
document is intended to be read by the project manager, software engineering directorate, and
customer where required.
1.2 System overview.
The SCS is a System that is made up of two entities: the Server (Professor / Group Leader) and
the Clients (Class / Users). These two entities will create a question and answer product where
the Server will send a question or questions to every Client. The Client(s) will then respond to
the Server with answers to the question or questions. The Server will then output statistics to the
screen for the Server to use as it feels fit. The Server also may save a standard set of statistics for
every question to a file after a question set has been analyzed. There is no user interface beyond
command-line displays as specified in the IDD.
Development began on September 29th, 2011, contracted and overseen by Dr. Jay Tevis.
Analysis, design and construction were completed for review on November 2nd, with quality
assurance procedures completed on November 7th.
Operating sites have not been disclosed by the customer as the product is designed to be mobile.
1.3 Document overview.
This document is intended to provide an overview of the SCS to the client. It contains an
inventory of the expected components in the SCS in this version, and is a guide for setting up
and installing both the Server and Client.
2
2. Referenced documents.
Document ID: DI-IPSC-8144
Originator: DATA ITEM DESCRIPTION MIL-STD-498
Issue: (December 05, 1994)
Title: SOFTWARE VERSION DESCRIPTION (SVD)
Applicability: Base standard for completing this Software Development Plan
Document ID: N/A
Originator: Project Manager
Issue: Version 6.2 (7 Nov 2011)
Title: Gannt Chart
Applicability: Used as baseline for System Overview
Document ID: N/A
Originator: Dr. Jay Tevis
Issue: Version 1.1
Title: Fall 2011 Introduction and Initial Planning
Applicability: Used as guideline for Software
3
3. Version description. This section shall be divided into the following paragraphs.
3.1 Inventory of materials released.
The SCS version 1.0 will be packaged in one zip file and will contain the following.
● SCS Software Version Description
● SCS Class Diagram
● SCS Final Source Code
● SCS Readme Text File
The source code is not considered the property of any developer and is freely distributable. Their
is no confidential or proprietary information contained within this release.
3.2 Inventory of software contents.
The software shall contain 2 folder, one for the Server and one for the Client source code.
Server:
●
●
●
●
●
●
●
●
●
●
●
Server.java
ExportManager.java
NetworkManager.java
Question.java
QuestionManager.java
Response.java
ResponseManager.java
ResponseResult.java
ScreenManager.java
ServerData.java
ServerManager.java
Client:
●
●
●
●
●
●
Client.java
ClientManager.java
NetworkManager.java
Question.java
QuestionManager.java
ScreenManager.java
Other
●
readme.txt (contains build instructions)
Their is no confidential or proprietary information contained within this release.
4
3.3 Changes installed.
N/A
3.4 Adaptation data.
N/A/
3.5 Related documents. This paragraph shall list by identifying numbers, titles, abbreviations,
dates, version numbers, and release numbers, as applicable, all documents pertinent to the
software version being released but not included in the release.Software Version Description
(SVD) (PDF version) DI-IPSC-81442
3.6 Installation instructions.
The Server shall be installed by extracting the ClickerServer folder from the provided zip file,
then inside the folder compile the source code and run the Server as specified in the readme.txt
file. The Client shall be installed by extracting the ClickerClient folder from the provided zip
file, then inside the folder compile the source code and run the Client as specified in the
readme.txt file.
A current Java JDK must be installed prior to compiling the either the Server or Client. A
compatible Java Run-time Environment must also be installed prior to running either the Server
or client.
The software requires access to open a network socket. To open this socket, the program may
require a firewall modification to the local operating system. This is considered normal
operation.
To determine whether the SCS Server was installed correctly, initialize the Server as specified in
the readme.txt file. It shall prompt you for the number of expected Clients. If this prompt does
not appear, the Server was not installed correctly. To determine whether the SCS Client was
installed correctly, initialize the Client as specified in the readme.txt file. It shall prompt you for
the Server’s IP address. If this prompt does not appear, the Client was not installed correctly.
All questions and support shall be directed to Dr. Tevis.
5
3.7 Possible problems and known errors.
3.7.1 Clients waiting for next question set
After the clients have completed a question set, all of them must be in the wait stage before the
Server sends out the next set of question. This is due to the JRE’s limitations on packet queueing.
3.7.2 IP Address displays incorrectly for Server on some Linux distributions
When initializing the Server, in rare circumstances it will display the localhost IP address of
127.0.0.1 instead of the local area connection IP address. If this happens, you can view the
Server’s IP address by opening a terminal and using the command “ifconfig” to display the LAN
settings.
6