Software Design Document

Russell Dixon
Simon Palenchar
Ryan Richardson
Erik Miller
Radford University Software Engineering
http://radfordwildcats.weebly.com/
4/18/2016

Wildcats

Software Design Specification

1 Contents
1 CONTENTS ................................................................................................................... I
2 INTRODUCTION ...........................................................................................................1
2.1 SYSTEM OVERVIEW ..................................................................................................1
2.2 SUPPORTING MATERIALS ..........................................................................................1
2.3 DEFINITIONS AND ACRONYMS ..................................................................................1
3 FUNCTIONAL REQUIREMENTS MAPPING OVERVIEW ...............................................2
4 HIGH LEVEL DESIGN ..................................................................................................6
4.1 CONCEPTUAL VIEW (ARCHITECTURAL CONTEXT MODEL) .......................................6
5 LOW LEVEL DESIGN ...................................................................................................7
5.1 PROCESS MODEL .......................................................................................................7
6 USER INTERFACE DESIGN ..........................................................................................8
6.1 APPLICATION CONTROL ............................................................................................8
6.2 SCREEN 1..N ..............................................................................................................8
7 FINAL SCHEDULE ......................................................................................................16

Page i

[ Organization Name ]

Deliverable - Software Design Specification

2 Introduction
2.1 System Overview
Deliverable is a mobile Android application that allows users to enter addresses into a
queue, optimize the route to those addresses, and display the directions. The user will be
provided directions back to the store once the queue is completed. When the user is returning
to the store, their location, name, and timestamp will be displayed to a manager through a
web interface.

2.2 Supporting Materials

None

2.3 Definitions and Acronyms

App Application

GPS Global Positioning System

Page 1

[ Organization Name ]

Deliverable - Software Design Specification

3 Functional Requirements Mapping Overview

Functional Requirement

Design Artifact

1: The manager shall have a textbox to

enter his username

4. Log-in Page

2: The manager shall have a textbox to

enter his password

4. Log-in Page

3: The manager shall be able to log in to

his account

4. Log-in Page

4: The manager shall have a driver

management page

7. Edit Driver Page

5: The manager shall have a table

displaying drivers, their last location, and
their timestamps

8. Home Page

6: The manager shall have a list of active

drivers

8. Home Page

7: The manager shall have a create user

page link

5, 6, 7, 8. All have a link in the banner

8: The manager shall be able to go to a

separate Create User page

6. Create Driver Page

9: The manager shall have a username

textbox on the Create User page

6. Create Driver Page

10: The manager shall have a password

textbox on the Create User page

6. Create Driver Page

11: The manager shall have a button on

the Create User page to submit

6. Create Driver Page

12: The driver shall have an Add Address

button

2. Address Screen

13: The driver shall be able to add their

address

2. Address Screen

14: The driver shall have an error message

appear when adding address fails

2. Address Screen

15: The driver shall have a list of every

address added so far

2. Address Screen

16: The driver shall have a log out button

2. Address Screen

Page 2

[ Organization Name ]

Deliverable - Software Design Specification

on the Address entry page

17: The driver shall be able to log out from
the Address page

2. Address Screen

18: The driver shall have an GO Optimized

button

2. Address Screen

19: The driver shall be able to choose an

Optimized Route

2. Address Screen

20: The driver shall be able to get a Cannot

Connect to GPS error message

3. Directions Screen

21: The driver shall have an GO As Is

button

2. Address Screen

22: The driver shall be able to choose an As

Is route

2. Address Screen

23: The manager shall be able to create a

new user

6. Create Driver Page

24: The manager shall be able to access an

Edit page

7. Edit Driver Page

25: The manager shall have a list of his

drivers and their passwords on the Edit page

7. Edit Driver Page

26: The manager shall have a remove button

next to each driver name on the Edit page

7. Edit Driver Page

27: The manager shall be able to remove

drivers

7. Edit Driver Page

28: The manager shall have a edit button at

the bottom of the Edit page

7. Edit Driver Page

29: The manager shall be able to edit existing

drivers usernames and passwords

7. Edit Driver page

30: The drivers device shall have location

services activated on their phone

3. Directions Screen

31: The driver shall have Google Maps

downloaded on their phone

3. Directions Screen

32: The drivers device shall have internet

access

1. Log-in Screen

33: The driver shall have an app button that

launches Deliverable

8. Users Mobile App Menu

Page 3

[ Organization Name ]

Deliverable - Software Design Specification

34: Only the manager shall have access to the

Deliverable website

4. Log-in Page

35: The driver shall have a Title screen

1. Log-in Screen

36: The driver shall be able to enter a

username into the Title screens username
textbox

1. Log-in Screen

37: The driver shall be able to enter a

password into the Title pages textbox

1. Log-in Screen

38: The driver shall have a log in button at

the bottom of the Title page

1. Log-in Screen

39: The driver shall be able to log into their

driver account

1. Log-in Screen

40: The driver shall be able to get a

Credentials Invalid error message

1. Log-in Screen

41: The driver shall be able to get a Cannot

Connect to System error message

1. Log-in Screen

42: The driver shall have an Address screen

2. Address Screen

43: The driver shall be able to enter an

address into a textbox on the Address screen

2. Address Screen

44: The driver shall have a Directions screen

3. Directions Screen

45: The driver shall have Navigate button

on the Direction screen

3. Directions Screen

46: The driver shall be able to go to the next

address

3. Directions Screen

47: The driver shall have a Next button on

the Direction page

3. Directions Screen

48: The driver shall be able to log out from

the Direction page

3. Directions Screen

49: The driver shall have a Log out button

on the Direction page

3. Directions Screen

50: The driver shall have a Return button

on the Direction page

3. Directions Screen

51: The driver shall be able to get directions

to return to the store

3. Directions Screen

52: The manager shall have a login page

4. Log-in Page

Page 4

[ Organization Name ]

Deliverable - Software Design Specification

on the website

Page 5

[ Organization Name ]

Deliverable - Software Design Specification

4 High Level Design

4.1 Conceptual View (Architectural Context Model)

Page 6

[ Organization Name ]

Deliverable - Software Design Specification

5 Low Level Design

5.1 Process Model

Page 7

[ Organization Name ]

Deliverable - Software Design Specification

6 User Interface Design

6.1 Application Control
Our system website has a banner displayed after log-in. The banner navigates
between the home, edit, and create pages. It also provides a log out button. The banner
includes a logo viewable on every page.
Each mobile screen has the ability to go back to the previous screen. A log out
button is common across all screens except the log in screen. Each screen has a white
background. All buttons are grey. All text is black. Deliverable is displayed at the top of
each screen.

6.2 Screen 1..n

1. Log-In Screen:

Page 8

[ Organization Name ]

Deliverable - Software Design Specification

The user will enter their e-mail and password then click the Log in button. If valid
credentials are entered, the user is taken to the address page. If invalid credentials are
entered, an error message will appear and the user will stay on this log-in screen.

2. Address Screen:

The user will enter their first address. If they have another, they will click the +
Another Address button. A new text field will be created below the last address that the user
will enter the address into. The user is limited to six addresses. When ready, the user will

Page 9

[ Organization Name ]

Deliverable - Software Design Specification

choose GO Optimized or GO As Is. The user will then be taken to the directions screen.
If Go Optimized was selected, the routes will be ordered closest route first. If GO As Is
is selected, the routes will be calculated one at a time, starting with the first address the user
entered. If Log Out is selected the user will be taken to the log-in screen.

3. Directions Screen:

A map of the users current location is displayed. The route to their current
destination is drawn on the map. If the user hits Navigate Google Maps navigation
application is launched. This will display turn-by-turn directions. If the user clicks Next
Address, the next address in their queue is displayed and mapped. When the user clicks
Return to Store, the store address will be routed and displayed. Log Out takes the user
back to the log in page.

Page 10

[ Organization Name ]

Deliverable - Software Design Specification

4. Manager Log-in Page

The manager will enter their e-mail address and password then click Login. If successful, the manager will be taken to the home page where active drivers
are viewable. If unsuccessful, the manager will receive an error message and remain
on this page.

Page 11

[ Organization Name ]

Deliverable - Software Design Specification

5. Home Page

On this page, the manager views two tables. The table on the left shows him
a driver, the time, and drivers location when the driver hits their Return button.
This table is updated constantly and gives the manager a general idea when to expect
the driver back at the store. On the right, a list of active, logged-in, drivers is
displayed. This table is also updated constantly because a driver may log in or out at
any time. Both tables are pulling driver information from the database. The
time/location table is being pushed information from drivers mobile devices.

Page 12

[ Organization Name ]

Deliverable - Software Design Specification

6. Create Driver Page

The manager gets to this page by clicking the Create a driver link in the banner.
To create a driver, the manager fills out the three fields provided (Name, Password, and
Phone). When they click Create Driver, if that driver does not already exist and the fields
are filled out correctly, a new driver is created in the database. A message will be displayed
that a driver was succesfully created, the fields will be reset, and the manager will remain on
the create a driver page. Otherwise, a message will be displayed that a driver was not
created, fields will remain, and the manager will stay on the page.

Page 13

[ Organization Name ]

Deliverable - Software Design Specification

7. Edit Driver Page

To get to this page, the manager will click the Edit Drivers link in the banner. All
drivers will be displayed with their name, password, phone number, and e-mail. If the
manager clicks the Edit button on a row, the manager is able to access and write into all
fields. Once proper changes are made, the manager will click Submit. On submit, the
database will be updated with the managers changes. All fields will become locked until
manager clicks Edit. If a manager clicks the Delete button, the corresponding driver will
be deleted from the database.

Page 14

[ Organization Name ]

Deliverable - Software Design Specification

8. Users Mobile App Menu

This is the users default app selection screen on their Android phone. Similar to a
desktop on a home computer. There will be a shortcut to open our app placed here. The
shortcut will be labeled Deliverable and have a picture of our team logo.

Page 15

[ Organization Name ]

Deliverable - Software Design Specification

7 Final Schedule

Page 16

[ Organization Name ]

Deliverable - Software Design Specification

Page 17