Software Design Document

Lexicon Industries:
Tsebaot Abera, Davon Davis, Sam Harrison, Gabe Porter, and Tevin
Scott
lexiconindustries.weebly.com
11/01/2016
1

Contents

Contents
Contents ................................................................................................................................... 2
1

Introduction ..................................................................................................................... 3
1.1

System Overview ...................................................................................................... 4

1.2

Supporting Materials ................................................................................................. 4

1.3

Definitions and Acronyms ........................................................................................ 4

Functional Requirements Mapping Overview ............................................................. 5

High Level Design.......................................................................................................... 14

3.1

Low Level Design .......................................................................................................... 15

4.1

Conceptual View (Architectural Context Model) ................................................... 14

Process Model (Data Flow Diagram)...................................................................... 15

User Interface Design ................................................................................................... 17

5.1

Application Control ................................................................................................ 18

5.2

Screen 1..n............................................................................................................... 18

Final Schedule ............................................................................................................... 28

6.1

Project Schedule...................................................................................................... 28

Introduction
Revisions

Version

Primary
Author(s)

Description of Version

Date
Completed

Draft Type
and
Number

Tevin Scott
Gabe Porter
Davon Davis
Tsebaot Abera
Sam Harrison

Version 1.0 Initial Document Creation

11/9/2016

Review & Approval

Requirements Document Approval History
Approving Party
Project Manager

Version
Approved

Signature

1.0

Date
Sam Harrison

11/9/2016

Dr. T. L. Lewis

Requirements Document Review History

Reviewer

Version
Reviewed

Signature

Date

Sam Harrison

1.0

Sam Harrison

11/9/2016

Tevin Scott

1.0

Tevin Scott

11/9/2016

Gabriel Porter

1.0

Gabriel Porter

11/9/2016

Tsebaot Abera

1.0

Tsebaot Abera

11/9/2016

Davon Davis

1.0

Davon Davis

11/9/2016

1.1

System Overview

The outcome of the project is to provide a Simple, usable way of searching and
browsing the librarys vast database of resources with a well presented graphical user
interface.

1.2
-

1.3

Supporting Materials
Android Studio
GitHub
Balsamiq
Java
Google Drive

Definitions and Acronyms

App - Application
RU - Radford University
SDK - Software Development Kit
ISBN - International Standard Book Number

Boolean
-

True/False values

Functional Requirements Mapping Overview

Figure 1 - main Login/ Sign-up Screen

Figure 2 - Sign up View

Figure 3 - Change password View

Figure 4 - Search refinement(Title)

Figure 5 - Search refinement(Author)

Figure 6 - Search refinement(Keyword)

Figure 7 - Search refinement(ISBN)

Figure 8 - Refinement deselected

Figure 9 - account settings menu

Figure 11-Exact Search using Quotation

Figure 10 - Boolean Operators in search field.

Figure 12 - Academic Search by keywords.

Figure 13 - Book Cover, Title, Author,

Published date, Description, Favorite icon
and Logout button

Functional Requirement

Design Artifact

1. User shall be able to enter

username in field, Allowing them to
specify their desired username
associated with their account

Figure 1

2. User shall be able to enter

password in field, Allowing them to
specify their desired username
associated with their account

Figure 1

3. User shall be able to click to login

to attempt to login using the entered
username/password

Figure 1

4. User shall be able to create an

account using the second link in the
view.
5. User shall enter first and last name
into the first text field when creating
an account.

Figure 1

Figure 2

6. User shall enter email address into Figure 2

the second text field when creating an
account.
Figure 2
7. User shall be able to create a
username into the third text field
when creating an account.
Figure 2
8. User shall be able to create a
password into the fourth text field
when creating an account.
9. User shall be able to confirm
password into the fifth text field when
creating an account.

Figure 2

10. User shall be able to change their

current password to a new
alphanumeric combination of their
choosing
11. User shall be able to enter book
title into the search field found at the
top over the view.
12. User shall be able to enter author
into the search field found at the top
over the view.

Figure 3

13. The user shall be able to refine

their search by the publish years
using the drop down menus
14. The user Shall be able to search
using keywords when looking for
books
15. The user Shall be able to search
using ISBN when looking for books

Figure 5

Figure 4

Figure 5

Figure 6

Figure 7

10

16. User shall be able to clear their

search using the clear search button
in account settings.
17. User shall be able to use boolean
operators in the search field
18. User shall be able to deselect
search refinement options to return to
a general search by pressing the
refinement button (Gear spinner)
19. User shall be able to search for
the exact title using quotations
around the search terms.
20. User shall be able to search for
any matching keywords inputted in
the database of academic journals.

Figure 9

21.System shall display book title.The

results of a users search should
show the book title.
22. System shall display book cover
of the book that was searched.
23. System will display the author of
the book that was searched.
24.System will display a short
description of the book that was
searched
25. Logged in user shall have the
option of favoriting the searched title.
Guest user shall be able to click the
favorite icon (star button) to add book
to favorites
26.The system shall have a built in
function to reset their username. User

Figure 13

Figure 10
Figure 8.

Figure 11.

Figure 12.

Figure 13
Figure 13
Figure 13

Figure 13

Figure 9

11

should be able to change username

by clicking on the accounts tab
27.The system shall have a built in
function to delete their account.
28. User shall be able to logout from
their account by clicking the logout
button located on the top right corner
of the page
29. User Shall be able to change their
password
30. User Shall be able to change their
username
31. User shall be able to delete their
account
32. User shall be able to logout from
their account by clicking the logout
button
33. User shall be able to view history
of searched books by clicking View
search history
34. User shall be able to clear history
of searches
35. User shall be able to clear history
of books read
36.The user shall be able to add their
favorite book.
37.The user shall be able to view
favorite book list.
38.The user shall be able to remove
favorite book list.
39.The user shall be able to pull up a
random book

Figure 9
Figure 13

Figure 3
Figure 9
Figure 9
Figure 13

Figure 9

Figure 9
Figure 9
Figure 13
Figure 4
Figure 9
Figure 10

12

40.The user shall be able to refine the Figure 10

random search

13

3
3.1

High Level Design

Conceptual View (Architectural Context Model)

14

4
4.1

Low Level Design

Process Model (Data Flow Diagram)

Level 0

Level 1 Login

15

16

User Interface Design

Level 1 Search

Level 1 Logout

17

5.1

Application Control

Upon activating the app, the user is brought to a general search screen with the option to login.
Presented at the login view are two text fields for username and password, a button to login in,
and a link to register. If the user enters credentials for a user that doesnt exist, an error message
is displayed and the user must re-enter a valid username and password. If the user doesnt have
an account, they can click the register link which will take them to a view presenting text fields
for name, email, username, password, and a register button. Clicking register after filling all
fields results in a user creation and takes the user back to the login screen.
A user can still utilize the app without creating an account. The will be brought to a general
search and can explore the Librarys resources. In the search, the user can refine their search to
ISBN, type, and year. When a search is executed, results are shown where the user can click
on an be presented with a thumbnail of the cover, the title, the author, publish date and a short
description. If a user is logged in, they have the option to save a book to favorites and a recent
history is automatically stored.
There is a link within the app where the user is presented with their account settings. Here the
user can change their username, clear their favorites and clear their history. They can also view
their current password.
At any time a user can logout of the system and continue to use the app as a non-registered
user.

5.2

Screen 1..n

18

19

20

21

22

23

24

25

26

27

6.1

Final Schedule

Project Schedule

See Attached PDF.

28