Stage 2 Requirements Documentation

tastefallInternet and Web Development

Feb 2, 2013 (5 years and 3 months ago)

165 views

Project Name:
Requirements Document (version 1.0)






1

OSU Libraries MobileLib Search Project
:


Requirements Document (version 1.0)


Project: MobileLib

Stage 2: Implementing a mobile search for the Library Catalog

Date(s): 5/20/09
-


Prepared by: Kim Griggs, Laurie Bridges and Hannah Rempel


1. Project Plan

T
his document contains the system requirements for OSU Libraries
MobileLib
project.
The project is split into three stages, this document is intended to aid in the development
of Stage 2.

Stage 1: An OSUL website for mobile devices


Completed

Stage 2: An O
SUL mobile application for searching our Catalog and other holdings
-

In
Progress

Stage 3: An innovative mobile application, such as an IPhone app or GPS


Future


1.1

Description of the Project


Stage 2 of MobileLib will

develop a mobile search application

for the library catalog and
course reserves system.

The resulting product of this project will add a search interface to
the MobileLib we
b
site for OSUL designed specifically for the limitations of mobile
devices.

1.2

Scope of the Project


Stage 2 will implem
ent a mobile catalog search
that allows users to look up an item by
keyword, title, author, call number? or ISBN and course reserves by course number or
instructor name. The mobile search results will be scaled back to fit the mobile use
context and will e
mphasize item location and item availability by clearly displaying call
numbers, floor location, and real time availability status. In addition the mobile search
application will provide SMS services that text the call numbers of an item to a patron
and a
hold request functionality that will allow a patron to place an item on hold.

Stage 2 main audience is students/patrons searching for items in the library catalog
through newer mobile devices.

Stage 2 will primarily consist of adding searching functionalit
y to the MobileLib site and
shall add 3 new interfaces.

Stage 2 will not add new static content to the existing mobile website but will add a new
menu item to the main navigation.

Stage 2 will not support older devices that can not render XHTML.

Stage 2
is a stand
-
alone component of the project and is not depend
e
nt on the other stages
to be successful.

Project Name:
Requirements Document (version 1.0)






2




1.3 Timeline and Methodology


Date

Milestone


(MS)

Goal

Depends
on

Req. Resources/People

Outcome

6/15

1

Finalize search
application
functionality

Fe
edback

MLib team, Team 200, U
-
Team

A list of
functionality
requirements:
see below

Request
made
6/16

2

Development and
Production
Infrastructure. Ryan
will need to set up
Ramaze and
hpricot. Maybe
upgrade ruby?

Ryan and
Stephen

Ryan, Stephen

Ramaze and
Hpricot
installed on the
servers.

6/30
-

texting

3

Code search
application
framework.

MS 1, 2

Stephen, Kim

Basic search
app coded to
standards

7/15

4

Design layout, write
content

MS 1,
designer,

MLib

Graphic designer, Mlib
team

Mock
-
ups of
layout desig
ns

7/15

5

Develop and test
layout with paper
prototype. Fix
issues and iterate.

MS 4,
users,
MLib team

MLib team, user test,
IRB?, users, UTeam

User tests and
result analysis.
Informal report.

7/20

6

Add layout to
search application
and integrate into
Mo
bileLib site

MS 3, 4, 5,
Stephen

Stephen, Kim

Completed
stage 2 of MLib
web site.

7/30

7

User Test with cell
phones and
evaluate project
goal evaluation. Fix
Issues and iterate.

MS 6,
MLib team,
Stephen,
users

MLib team, user test,
IRB?, users, staff, mob
ile
devices, UTeam

User testing of
website on
mobile devices.
Formal goal
evaluation and
report.

8/15

8

Move to production
site.

MS 7,
Ryan

Ryan, Stephen and MLib
team

MLib available
at public
website and
tracked by
urchin

8/15

9

Release

MS 8,
MLib tea
m,
team 200

MLib team, team 200,
OSUL website, OSU
marketing?

Advertisements
on OSUL
website, OSU
marketing




MS

Responsible

Issues

New
Date

1

MLib



Project Name:
Requirements Document (version 1.0)






3

MS

Responsible

Issues

New
Date

2

Stephen



3

Stephen/Kim



4

Kim



5

MLib



6

Kim/Stephen



7

MLib



8

Stephen



9

Laurie






2. Project Description


2.1 Project Stakeholder Scenarios


Students

“I can't count how many times I'm in the compact shelves reading a journal, and in the
references I'll see some other article that looks relevant. It would be great to pull out my
phone

right there, look up the journal location for that new article and head directly to its
location. That's just something I think would be nice to have.”


Reference Staff

When I am helping a patron find a book I sometimes have to leave them to look up the
c
all number on the closest computer. It would be easier if I could look it up on a porta
b
l
e

devi
c
e as we walk around.


General Public

“The mobile website was very helpful in helping me find my way to the library, now if it
would only help me find a book!”


2.2 Project Functions


Stakeholders will be able to use their mobile devices to search the Libraries’ catalog from
a specialized OSUL website that is designed for the limitations of mobile devices. They
will be able to easily search the catalog through an
easy to use and attractive mobile
website that takes into account the mobile search context.



2.4 General Constraints and Restrictions


Technology Restrictions:



Dynamic scripting such as javascript, flash are not supported by the majority of mobile
device
s.

Project Name:
Requirements Document (version 1.0)






4



Cache size and bandwidth: Due to the small sizes of both, large images and image
intensive pages should be avoided. Page length should also be kept as short as possible
and possibly broken up into multiple pages if necessary.



Coding static pages in XHTM
L will prevent some older/simpler phones from accessing
the site as older devices require pages to be coded in WML. This was deemed acceptable
in our initial project meeting.

Device Restrictions



Screen size: Due to the varying number of screen sizes, pages

will have to be designed to
accommodate both larger screens of the iPhone, Blackberrys, etc. as well as small screens
of more standard cell phones.



Navigation/Forms: The site navigation and forms need to be quick and easy to use for
users with touch scree
n capabilities as well as standard scroll navigation methods.



Constraints

Issues/Solution (I/S)


Section 508

(S) Valid XHTML


Must work for a wide variety of mobile
devices

(S) Valid XHTML, testing


Must be branded as OSU site

(S) Logo and color sch
eme


Must be extendable

(I) Code, design and navigation


Screen Size

(S) Use min
-
width to set to medium
size and then auto to adjust. Limit
height of navigation pages to
medium.


Technologies and bandwidth

(I) javascript , Images, flash


Design (navig
ation, page length)

(I) work with touch and key pad,
(S) short content



2.5 Assumptions and Dependencies


Assumptions

Project will be delivered over the Internet and hosted on OSUL servers. We assume staff
will help in advertising and testing and MLib te
am will have time to work on the project.
We assume users will be viewing the web pages on a newer device with adequate
bandwidth.


Dependencies

The project is dependent on the MLib team’s time and abilities. It is also dependent on a
server admin’s and g
raphic designer’s time, server space, and feedback from
stakeholders. The success of the project depends on adequate advertisement and making
the mobile website discoverable.



Project Name:
Requirements Document (version 1.0)






5

3. Project Requirements


3.1 User Requirements


1.

Easy to navigate on a wide va
riety of mobile devices

2.

Easy to read information on small screens

3.

Short concise content

4.

Easy to use mobile search interface

5.

Easy to fill out forms with drop downs and check boxes

6.

Most links on pages shall link to mobile pages (exceptions will indicate with

an
icon that links are not mobile friendly)

7.

All phone numbers shall also be links that automatically call

8.

The pages shall load quickly and render correctly on most mobile devices

9.

SMS Services shall be easy to use and provide user with pertinent content. A
ll
SMS services shall also be mimicked with an email service

10.

Requesting a hold shall be easy to do and require the least amount of data (this
may not be possible)




3.2 Functional Requirements




Catalog Search by
keyword, title, author, call number, ISBN



S
earch by Keyword default



Course Reserve Search by class or instructor



Course reserves search default is course num



Filter by branches



Branches default is all



Limit by result set size: options (1, 5,10)



Result set size default is 5



Call numbers are mapped
to floor location and displayed along side



SMS texts title, author, call number and floor location



Email option emails title, author, call number and floor location



Request hold submits to Oasis (may not be possible)



Home Page and layout



The home page sh
all include a link to the search application



A link to search shall be added to the footer of the
M
obile
L
ib layout


Main Navigation



The navigation shall look consistent on all pages



The navigation shall be easy to use and include shortcuts



Links shall be l
imited to number of keys available



All links shall have a alpha numeric link assigned to it


Project Name:
Requirements Document (version 1.0)






6

Footer



The footer shall look consistent on all pages


Search Home Pages



The search home page shall use the MobileLib header and footer



The search home page shall i
ncorporate the search icon



It shall provide links to parent and related resources



The search form shall use drop downs and checkboxes when possible



The search form shall allow a quick search and advanced search on one page



A quick search shall use pre
-
popu
lated advanced search options



The search interface shall provide options to search by
keyword, title, author, call
num, ISBN



The search shall provide options to search course reserves by professor or class



The search form shall provide filtering options s
uch as result set size and branches



Search Results Pages



The search results page shall use the MobileLib header and footer and include the
search icon



The results page shall be paginated into smaller result sets that is preset to 5 or set by
user through

filtering option



The results page shall display title, author, call number, floor number, location and
availability



In the event that more than one location is found the results page shall only show the
first location with a link to more



In the event tha
t the item is not available show title and checked out mssg only



The item’s title shall link to each item’s record



The items call number shall show the floor number and link to map



The search results page shall provide a link to start a new search



The pag
ination shall load result pages quickly



The pagination shall allow users to jump to desired page as well as browse through
the results with a next and previous button


Item Record Page



An item’s record page shall display title, author, call and floor numbe
r, location, and
content or summary/description. Content and description shall be truncated to a
man
a
g
e
able length.



In the event an item is a seri
a
l then the record shall show information about what the
library owns. Links out of of mobile context shall b
e marked with an icon.



If more than one location is found all locations shall be displayed.



It shall include a link back to search results and to start a new search.



An item’s record shall provide SMS and email service to text/email an item’s title,
autho
r, call number and floor location
.

Project Name:
Requirements Document (version 1.0)






7



(might not be possible) An item’s record shall allow a user to request a hold on an
item item for pick
-
up.



(might not be possible) The request a hold form shall mimic the catalog’s form.



An item’s record shall provide pa
gination through the result’s records without having
to go back to the search results page.



An items record shall provide a link to the ‘shelf view’ based on call number.



Code



Code shall be valid XHML & CSS & Section 508



Code shall follow OSU/OSUL standa
rds and requirements



Code shall be re
-
usable, well commented, compatible and extendable.


3.3 System Requirements and Software Interfaces


System Requirements



Ramaze, Hpricot, Ruby (get versions)


Software Interfaces

Stage 2 is required to interface with t
he MobileLib and OSUL website look and feel and
will be joined through links on both systems.


Future stages shall be required to interface with any or all of the following systems:



Library ala Carte



Drupal



E
-
Journals



ScholarsArchive



Databases of Database
s



Site search


3.4 User Interface Requirements


1.

Conciseness

Do not require user to scroll on navigation pages. Chunk information into
sections. Paginate search results.

2.

Limiting Links to number pad

Assign each link to a number on phone pad. Do not exceed
that limit. Display
each link with assigned number.

3.

Descriptive Icons

Assign each navigation link an icon. Use icon as a preview of content

4.

Home and Parent Link

Include Home icon and link on each page. Add links/icons to parents and related
pages of interi
or pages.

5.

Footer information

Project Name:
Requirements Document (version 1.0)






8

Add Link to main OSUL website and site map in footer of all pages. Add info
about mobile site to home page. Add link to search to footer.

6.

Layout

Layout should be consistent with MobileLib site.

7.

Extendable

Design must be able to

be extended to other stages and to grow in use and links.

8.

Screen Sizes

Design should target 176X220, but should work for all sizes.



128X160


176X220


320X240

320X480



Project Name:
Requirements Document (version 1.0)






9






3.4 User Interface Mock
-
ups and Examples

Flickr stream of mobi
le interfaces:
http://www.flickr.com/photos/users_lib/collections/72157606321236862/

QuickTime™ and a
TIFF (Uncompressed) decompressor
are needed to see this picture.

QuickTime™ and a
TIFF (Uncompressed) decompressor
are needed to see this picture.


Project Name:
Requirements Document (version 1.0)






10

QuickTime™ and a
TIFF (Uncompressed) decompressor
are needed to see this picture.

QuickTime™ and a
TIFF (Uncompressed) decompressor
are needed to see this picture.





4. High
-
Level Technology Architecture




Ramaze: Light
-
weight Ruby Framework.



Hpricot: Ruby HTML parser



Ruby



Hosted on Unix servers.


5. Maintenance and Sup
port




Server admin will support server and Internet connection.



Programmer shall support code and upgrades.



MLibTeam shall support evaluation and testing.


6. User Testing and Evaluation


Test 1

Testing: Design, layout and navigation

Objective: Evaluate
search interface design

Artifacts: Project Prototype (paper or cell phone emulator)

Users: 3 stakeholders

Tasks: Search and find by topic and known title

Project Name:
Requirements Document (version 1.0)






11


Test 2

Testing: Mobile website on a wide range of mobile devices

Objective: Evaluate the interface a
nd get staff feedback

Artifacts: Mobile websites, mobile devices, staff email, feedback forum

Users: Staff at large, 3
-
5 stakeholders

Tasks: Ask users to perform tasks on mobile devices and provide feedback


Test 3

Testing: Project Goals

Artifacts: Heurist
ic evaluation guide, completed project

Users: MLib team

Tasks: Perform evaluation


Evaluation

Testing: Long term use and project success

Artifacts: Web use statistics

Tasks: Track use statistics



7. Appendix



8. Resources
https://www.techylib.com/en/view/tastefall/stage_2_requirements_documentation
www.techylib.com
crawl=CC-MAIN-2018-17
66248
application/http; msgtype=response
sha1:V7N4CQS66O3MPEBUTHKMLT5FQWXC3FZN
<urn:uuid:71b26e39-431e-42fa-b844-beb9f5977c60>
2018-04-23T22:10:34Z
54.235.70.28
application/xhtml+xml
sha1:DRA6VUHQ7KLGI5E5GSUFHNUCGCOBCFYR
<urn:uuid:9c71c95d-f8b3-4e32-a743-3ef63c161fa3>
https://www.techylib.com/en/view/tastefall/stage_2_requirements_documentation
length
response
<urn:uuid:65461412-d602-41e9-be17-d8d1dc195130>
robots: classic
hostname: ip-10-146-34-165.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2018-17
operator: Common Crawl Admin
description: Wide crawl of the web for April 2018
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf