University of Moratuwa OOWebSearch Software Requirements Specification

Version <1.0>

Revision History
Date 15/10/09 Version <1.0> Description Primary version of the Software Requirements Specification Document. Author Wijekoon S. A. K. 070543E

Table of Contents
1. Introduction 1.1 Purpose 1.2 Scope 1.3 References 1.4 Overview 2. Overall Description 2.1 Product Perspective 2.2 Product Features 2.3 User Characteristics 2.4 Principal Actors 2.5 Constrains 2.6 Assumptions and Dependencies 3. Specific Requirements 3.1 Functionality 3.2 Usability 3.3 Reliability 3.4 Performance 3.5 Supportability 3.6 Design Constraints 3.7 Interfaces 3.7.1 User Interfaces 3.7.2 Hardware Interfaces 3.7.3 Software Interfaces 3.7.4 Communications Interfaces 3.8 Applicable Standards 4. Supporting Information 5 5 5 5 5 5 5 5 6 6 6 6 6 6 6 7 7 7 7 7 7 7 7 8 8 9

Software Requirements Specification

1. Introduction
This document gives an organization of the requirements of the OOWebSearch project, which is an extension developed for OpenOffice package. This document captures a complete set of requirements for the project while using the use-cases as a tool. 1.1 Purpose The Purpose of this document is to clearly identify the functional, non-functional and domain requirements of this project. It is expected to provide a clear description about the user requirements at the implementation phase. 1.2 Scope The project is an extension for OpenOffice.org package which will allow the user to do a web search on a particular word or a phrase which came across when working on OpenOffice package. It uses OpenOffice as the primary code base. 1.3 1. 2. 3. 4. References OpenOffice official website. http://www.sun.com/software/openoffice Rational Unified Process templates on SRS. http://www.ts.mah.se/RUP/RationalUnifiedProcess CS3020 Lecture Notes Sample Documents from the web.

1.4 Overview The rest of the document contains the following details as listed below. 1. Overall Description Overall Description about 2. Specific Requirements Lists all functional, non-functional and domain requirements gathered from the document. 3. Supporting Information gives Use-case diagrams to explain the users perspective and the stakeholders perspective on the project.

2.

Overall Description

2.1 Product Perspective The basic requirement of the OOWebSearch tool is to reduce the time wasted by the OpenOffice user to do a web search. This is an extension for the OpenOffice package, which should be installed externally. 2.2 Product Features The following features are recognized as the essential items to develop the extension which will fulfill the main requirement. 1. Highlight the word or the phrase. 2. Go to OOWebSearch. 3. Select preferred Search Source 4. Viewing Results 5. Modifying Search options.

2.3 User Characteristics User should be familiar with OpenOffice package. User should be familiar with the internet. 2.4 Principal Actors Principal actors for this product are the user and the Lectures of the department. 2.5 Constrains The major constrain of this project is the time limitation. The project should be done withing the given period of time. 2.6 Assumptions and Dependencies This feature is dependable on an available internet connection to the machine.

3.

Specific Requirements

3.1 Functionality This section of the document describes the functional requirements of the OOWebSearch in a natural language style. Installing and Uninstalling User can go to extension manager and add or remove the extension from OpenOffice. Highlighting the word or the phrase When the user wants to search for a definition or details about a word or a phrase which he or she comes across while working on OpenOffice, user should first highlight the word or the phrase. Go to OOWebSearch Click on the OOWebSearch option to activate the OOWebSearch tool. Select preferred Search Source Select the source which the user wants to do the searching. Viewing Results The results of the search result is displayed in a very attractive manner. Modify Search options The User Interfaces which will provide options to add new Search places and remove default search places.

3.2

Usability There is need to train to use this component if the user is familiar with OpenOffice package, since this component is designed such that it become visible right after the extension is installed to the OpenOffice package. User may need instructions on how to add the extension to the OpenOffice package which will be provided with the product as a readme document. The estimated time taken for a single search will be approximately 2-3 seconds. But this is approximated assuming that the internet connection is reliable. It will take more time depending on the speed of the connection. This extension is developed such that it adheres to the guidelines provided by the OpenOffice Extension Developers Guidelines posted in the OpenOffice official website.

3.3

Reliability Once this feature is added to the OpenOffice package it is available to used until it is uninstalled or disabled as an extension for OpenOffice package. There is a high reliability to view a search result for a given word or a phrase provided that there is a available internet connection. This extension will provide hundred percent accurate search results for the word or the phrase selected by the user, but the relevance of the search results are not considered at this level.

3.4

Performance The response time for a typical search should be between two to three seconds. This can only show one search results option at a time. This will not affect or depend on other web related activities going on in the machine.

3.5

Supportability This extension should be according to the OpenOffice Extension development guidelines. The coding should be maintainable. The coding should be extendable. The coding should follow Object Oriented coding styles.

3.6

Design Constraints The design of this extension should be compatible with the existing OpenOffice version of the user. It is compatible with OpenOffice.org 3.1.1 and above. The design should be appropriate such that it is able to finish by the given time schedule.

3.7 3.7.1 1. 2.

Interfaces User Interfaces User Interface to select a search option This is a drop down list which will show available search places and an option modify that list. For example it may contain options such as Google search,Yahoo search or Wikipedia Search. User Interface to modify search options This is a dialog box where the user can modify preferred search options. There will be an option to add and remove search options.

3.7.2 Hardware Interfaces There is no specific hardware needed to use this tool since it is not a stand alone application. OpenOffice hardware requirements apply here. 3.7.3 Software Interfaces The OpenOffice software interface is considered as the software interface to this extension.

3.7.4 Communications Interfaces This tool connects to the available internet connection using a web browser to search for a given query. The internet connection will be provided by a Internet Service Provider.

3.8 Applicable Standards The standards applied to this project are as mentioned in the official website for OpenOffice Extension Development. http://wiki.services.openoffice.org/wiki/Extensions_development#Articles_.26_Tutorials

4.

Supporting Information

Use-case Diagram

Use-Case Installing the extension

Actor User

Description To install the extension first user has to get the oxt file of the extension. Then user have to go to Tool->Extension Manager. Then click on ADD button and give the path to the oxt file. Then OpenOffice will automatically install the extension to the OpenOffice package. To separate the word or the phrase user wants to do the web search user should highlight that text. By selecting the OOWebSearch option the extension is activated and the selected text will be sent to the program. User can choose from which source he or she wants to view the search result. The obtained results will be displayed to the user so that user can do further search on that or read through it. By default the extension will contain some most popular search options like Google Search or Wikipedia. If the user wants to go to a specific page he or she prefers it should be added beforehand through this dialog box. There user is asked to give the URL to the web page. If the user feels like some of the searching options are redundant according to his or her needs they can be removed from this dialog box. There the user can select it and remove it easily. User can uninstall the extension by going to Extension Manager and by clicking Remove or Disable. Evaluate the project by going to each option and checking the functionality of them.

Highlighting a word or a phrase Click on OOWebSearch Select a preferred search source View Result Add more preferred search places

User User User User User

Remove search places

User

Uninstalling the extension Evaluation

User Lecturer