Software Requirement Specification For Directory Script Project Page 1 of 27

Software Requirements Specification

For

Directory Script

Version #:01

Prepared For:
Scott Boyd

Prepared By:
Amit Joshi
Key Solution India Inc

Creation Date: 28 May 07

Approved by:

Seema Sonkiya
Software Requirement Specification For Directory Script Project Page 2 of 27

Table of Contents

Table of Contents.............................................................................................................2
Revision History...............................................................................................................3
1. Introduction.................................................................................................................4
1.1 Purpose...................................................................................................................4
1.2 Document Conventions...........................................................................................4
1.3 Intended Audience and Reading Suggestions.......................................................5
1.4 Project Scope..........................................................................................................5
1.5 References..............................................................................................................6
2. Overall Description....................................................................................................6
2.1 Product Perspective................................................................................................6
2.2 Product Features..................................................................................................18
2.3 User Classes and Characteristics.........................................................................20
2.4 Operating Environment.........................................................................................20
2.5 Design and Implementation Constraints...............................................................20
2.6 User Documentation.............................................................................................20
2.7 Assumptions and Dependencies..........................................................................21
3. System Features.....................................................................................................................21
4. External Interface Requirements............................................................................21
4.1 User Interfaces......................................................................................................21
4.2 Hardware Interfaces..............................................................................................26
4.3 Software Interfaces...............................................................................................26
4.4 Communication.....................................................................................................26
5. Other Nonfunctional Requirements.......................................................................27
5.1 Performance Requirements..................................................................................27
5.2 Safety Requirements............................................................................................27
5.3 Security Requirements..........................................................................................27
5.4 Software Quality Attributes...................................................................................27
6. Other Requirements.................................................................................................27
Software Requirement Specification For Directory Script Project Page 3 of 27

Revision History

Name Date Reason For Changes Version

Custom Link Directory Script 28 May 2007 Created 1.0

Project
Software Requirement Specification For Directory Script Project Page 4 of 27

1. Introduction

1.1 Purpose :

The purpose behind the SRS document is to describe the resources and their
management used in the design of “Custom Link Directory Script”. This SRS will further
provide details regarding the functional and performance related requirements of
“Custom Link Directory Script”. This document will overview the product, and gives a
detailed specification for the developers. This document also discusses the projects
goals and parameter, while giving description of the user view and potential issues.
Requirements are specified according to the finished product.

1.2 Document Conventions

Headings:
Font Name -Arial
Font Style - Bold
Font Size -14,
Font Type - Headings2

First Level Sub Heading:

Font Name -Arial
Font Style – Bold
Font Size – 12
Font Type – Body Text

Body Text:
Font Name – Arial
Font Style – Regular
Font Size – 12
Font Type – Body Text
Software Requirement Specification For Directory Script Project Page 5 of 27

1.3 Intended Audience and Reading Suggestions

This document is intended for software developers, project managers, testers,

documentation writers and client of the project.

1.4 Project Scope

Custom Link Directory Script is a web based solution which will be used to build
online directory to register advertisers listing under specific categories. The application
section also used to manage user roles, their privileges and responsibilities. Content
management section will let admin user to create/edit static pages to manage site
content.

Basically this application has eight main parts –

User Management – The user management subsystem will work that are related to the
general user’s management tasks of the system like create user assign privileges to
relevant users.

Category Management System – This section will be used to manage categories such
as category creation, edition and query related to category etc.

Listing Management System – Member can add listings using “Suggest a Site”
functionality. There will be two type of listing – Premium and Free.

Advertisers Management System– The Advertiser Management subsystem will work

on the listing advertiser’s part of the systems such as advertiser creation and query
related to advertisers.

Email Management System – E-Mail Management Subsystem will be responsible to

manage various listing events like listing submission, approval from admin user and
their upgrading. This subsystem will also be used to e-mail user groups.
Software Requirement Specification For Directory Script Project Page 6 of 27

Content Management System– Content Management System will be used to facilitate

the users to manage the web solution while in air with virtually no technical training. The
Content Management System will allow the admin user to change/edit the contents of
pages that

Revenue Sharing System – Revenue sharing system will be used to manage Adsense
adverts. System will maintain revenue share ratio for page views that will be editable by
admin user.

Reports: Reporting system will let the admin user to view the reports related to other
users like Editors and Meta Editors and their listing submissions.

1.5 References

The Client will provide most of the references for this project. The client will provide the
team with all the information that will be pertinent to the
1.5.1 product.directory-technical-spec
1.5.2. Response to our queries “DirectoryScript28May07”

2. Overall Description

2.1 Product Perspective

The system will be developed as a web application and it will use resource of
database server to manage application data.

The following diagram shows basic structure of custom directory script project:
Software Requirement Specification For Directory Script Project Page 7 of 27

C u sto m Lin k Dire c to ry Sc rip t

We b Ap p lic a tio n Lo g in Win d o w

Typ e s o f Use rs
Re so u rc e s a n d Au th e n tic a te th e Use r

META
ADMIN EDITO R USER
Use r Ho m e Pa g e / C o re Pro c e sse s EDITO R
*
*
* *
*
* *
* *
Su g g e st site fo r
Ma n a g e C o n te n t
b a sic o r p re m iu m
Ma n a g e m e n t Syste m
Use r Ma n a g e m e n t listin g s re la te d to
A De fin e sta n d a rd e -m a il
Syste m sp e c ific c a te g o ry.
** * * te m p la te .
De fin e re ve n u e sh a re
ra tio a m o n g h im se lf,
e d ito r a n d Me ta e d ito r.
C a te g o ry De fin e c a te g o rie s
B
Ma n a g e m e n t Syste m Mo vin g d e le te d C h e c k if listin g s
** * *
c a te g o ry to a n o th e r a re a d d e d
c a te g o ry. * p ro p e rly b y Ed ito rs
Ap p ro ve / d e c lin e / e d it Su p e rvise o th e r
Listin g Ma n a g e m e n t n e w su b m issio n s (listin g s) e d ito rs
C fo r c a te g o rie s. **
All Fu n c tio n s o f
syste m
** * * Ed it o th e r u se r’s d e ta ils. Ed ito r
C h a n g e a c c e ss
p rivile g e s
** Vie w a list o f e d ito rs
Ad ve rtise r’s Vie w site s a p p ro ve d /
D
Ma n a g e m e n t Syste m
* * e d ite d / re je c te d b y * Pa rtic ip a te in th e
e d ito rs re ve n u e sh a re
Ac c e p t/ De c lin e th e sc h e m e .
** a p p lic a tio n fo r b e in g * * Ap p ro ve /
Em a il Ma n a g e m e n t e d ito r. d e c lin e / e d it n e w
E
Syste m Pro m o tio n o f e d ito r to su b m issio n s
* *
Me ta Ed ito r Ap p ly to e d it
Assig n n e w c a te g o rie s to a d d itio n a l
m e ta e d ito rs. c a te g o rie s u sin g
*
C o n te n t Ad d / Ed it in stru c tio n fo r th e e d ito r c o n tro l
F “Su g g e st a Site ” p a g e p a n e l.
Ma n a g e m e n t Syste m
* * Ma n a g e e d ito ria l
g u id e lin e to h e lp e d ito r
a p p lic a n t.
Ma n a g e b e n e fits o f
Re ve n u e Sh a rin g p re m iu m listin g
G
Syste m Re vie w u p g ra d e listin g
** * *
a p p lic a tio n
* Re vie w o f b a d listin g
re p o rtin g
De fin e a d ve rts tim e fo r
Re p o rts H
re ve n u e sh a re a m o n g
** * *
a d m in , e d ito r a n d Me ta
Ed ito r
Software Requirement Specification For Directory Script Project Page 8 of 27

A B

* *
* *

Use r Ma na g e m e nt Syste m Ca te g o ry Ma na g e m e nt Syste m

* *
* *

C re a te Use rs C a te g o ry Na m e
C a te g o ry c re a tio n
C re a te Ro le s C a te g o ry De sc rip tio n
C re a te Rig h ts Ed it c a te g o ry d e ta ils
De le te – Mo ve Listin g to a n o th e r C re a tio n Da te
Assig n Rig h ts/ Visib ility Sta tu s (Ac tive / In a c tive / De le te )
C a te g o ry
C h a n g e Pa ssw o rd
URLs to re p la c e th e sp a c e
Use r Au th e n tic a tio n
b e tw e e n c a te g o ry n a m e w ith a
h yp h e n .
Alp h a b e tic a l so rtin g o f c a te g o ry

C
*
*

Listing Ma na g e m e nt syste m

Fre e Listin g in fo rm a tio n Site Na m e

Pre m iu m Listin g In fo rm a tio n Site URL
An ti sp a m p ro te c tio n a t Listin g * Sh o rt site d e sc rip tio n (m a x. 200
** c h a ra c te rs)
Su b m issio n
Pre m iu m listin g o n to p c a te g o ry C a te g o ry (Dro p d o w n list)
p a g e w ill b e sh o w n re c e n t Em a il C o n ta c t (w ith a n ti
a d ve rts fro m a ll su b c a te g o rie s. h a rve ste r p ro te c tio n )
Ve rific a tio n o f e m a il a d d re sse s C h e c k b o x to re c e ive e -m a ils
b e fo re b e e n a d d e d to “p e n d in g ”
a d m in q u e u e . *
Sta tu s o f listin g E xte n d e d d e sc rip tio n fie ld (Ma x.
1000 c h a ra c te rs
P re m iu m liste r c a n c h o o se o n e
p rim a ry c a te g o ry (a p p e a r a s
p rim u m listin g ) & 4 se c o n d a ry
Un d e r ve rific a tio n c a te g o rie s (a p p e a r a s n o rm a l
Pe n d in g listin g )
Ap p ro ve d Pre m iu m listin g w o u ld d ire c tly lin k
Re je c t to se rvic e s/ o th e r p a g e s o f site
De le te d (Ma x. 4)
To Up g ra d e Lo c a tio n (te xt fie ld )
To Ba d Re p o rt Te le p h o n e
Ac c e p t Ba d Listin g Use rn a m e a n d p a ssw o rd
Da te Ad d e d
Software Requirement Specification For Directory Script Project Page 9 of 27

D E

* *
* *

Ad ve rtise r’s Ma na g e m e nt Syste m Em a il Ma na g e m e nt Syste m

* *
A listin g is
Ma n a g e in fo rm a tio n o f su b m itte d
Ma n a g e va rio u s listin g e ve n ts.
a d ve rtise rs A listin g is
Em a il se n t w h e n * *
Use o f re g istra tio n Fo rm w h e n a p p ro ve d o r
E-m a il u se r g ro u p s
“Su g g e st a Site ” fu n c tio n a lity d e c lin e d
w o u ld b e u se d A listin g is
Ad ve rtise rs “fu ll p a g e listin g ” is a u p g ra d e d
p re m iu m listin g . O n c lic kin g a fro m b a sic to
p re m iu m , listin g use rs w o u ld b e p re m iu m
Ju st e d ito rs
d ire c te d to a fu ll p a g e listin g Ju st m e ta
d e sc rib in g th e w e b site . e d ito rs
Ju st p re m iu m
a d ve rtise rs
Ju st b a sic
F G listin g s
To a ll u se rs
* **
*

Co nte nt Ma na g e m e nt Syste m Re ve nue Sha ring Syste m

* *

Ad m in c a n e d it h e a d e r a n d Ma n a g e Ad se n se a d ve rts All su b

fo o te r o f th e w e b p a g e s. Ad se n se w ill a d d c a te g o ry
Ad m in c a n Ad d / Ed it in stru c tio n Ma in ta in re ve n ue sh a re ra tio pa ges
fo r “Sug g e st a Site ” fu n c tio n a lity fo r p a g e vie w s All p re m iu m
Ad m in u se r c a n a d d / e d it Wo rkin g o f Re ve n u e Sh a rin g listin g p a g e s
e d ito ria l g u id e lin e fo r “Be c o m e * *
a n e d ito r” fu n c tio n a lity
Ad m in c a n a d d / e d it “Ab o u t u s” Ad se n se a d ve rts
pa ge. d isp la ye d “b e lo n g ” to
Ad d / Ed it in stru c tio n fo r “Su g g e st a d m in .
a Site ” p a g e Wh e n a n e w e d ito r is
Ma n a g e e d ito ria l g u id e lin e to a c c e p te d , th e ir
h e lp e d ito r a p p lic a n t. a d ve rts a p p e a r w ith in
Ma n a g e b e n e fits o f p re m iu m th e ir c a te g o ry fo r a
listin g c e rta in p e rc e n ta g e o f
th e tim e
Wh e n a n e w Me ta
e d ito r is p ro m o te d ,
th e ir a d ve rts a p p e a r in
th e ir o w n c a te g o rie s a s
w e ll a s in su b
c a te g o rie s m a n a g e d
b y e d ito rs u n d e r th e ir
c o n tro l.
If a n e d ito r is
re m o ve d , th e n th e
a d ve rts in th e ir
c a te g o ry re ve rt to
a d m in o n ly.
Software Requirement Specification For Directory Script Project Page 10 of 27

*
*

Re p o rts

Pe n d in g b a sic listin g s

Pe n d in g p re m iu m listin g s
Ed ito r list / Me ta e d ito r list
Ap p ro ve d / Re je c te d listin g s
list
G e n e ra l sta tistic s Ho w m a n y Ba sic listin g
Pre m ium listin g s
Ed ito rs
Me ta e d ito rs
Ne w listin g s p e r d a y

a. User Management: - User of the system will be defined by the existence of a custom
link directory account, although general users can visit site without any login account
but in this case they cannot perform any operation. There will be 4 level of user
access:

 Admin: Admin user will have full access to everything. System will have an admin
control panel from there admin can perform their defined responsibilities.

 Editor: Editor User can approve / edit listings within their own category. System
will have an editor control panel from there editor can perform their defined
responsibilities.

 Meta Editor: Meta editor user monitor and edit their own category listing
submissions and those of editors which they oversee (defined by admin). System
Software Requirement Specification For Directory Script Project Page 11 of 27

will have a Meta Editor control panel from there Meta Editor can perform their
defined responsibilities.

 User: other users can manage their own premium listings. It is compulsory to login
to manage listings Registration form will be incorporated to sign up any new list
user.

Detailed responsibilities/functions of Each User Group:

 Admin User: Admin user is responsible to overall management of application
like:
 All functions related to content management functionality. (CMS features
defined below)
 Email to specific user groups or to all groups. Admin will be responsible
define standard e-mail template.
 Define revenue share ratio among himself, editor and Meta editor.
 Define categories
 If a category is deleted then admin will have the option to move listings to
another category.
 Admin user will be able to approve / decline / edit new submissions (listings)
for categories.
 Admin user can edit other user’s details and change access privileges.
 Admin will be able to view a list of editors and see which sites they have
approved / edited / rejected
 When a user applies to become an editor, this information will be available to
admin user who can then accept or decline the application; in either case
admin will be able to add notes for the editor which is sent via e-mail.
Standard e-mail message will be defined by admin for this operation.
 Promotion of editor to Meta Editor
 Assign new categories to Meta editors.
 Add/Edit instruction for “Suggest a Site” page
 Manage editorial guideline to help editor applicant.
Software Requirement Specification For Directory Script Project Page 12 of 27

 Manage benefits of premium listing

 Review upgrade listing application
 Review of bad listing reporting
 Define adverts time for revenue share among admin, editor and Meta Editor

 Editor: Editor User will be responsible (along with admin and their Meta editor)
to overall control of listing submissions of categories for which they have applied
and approved by admin user: The “editor application link” is a link to a form that
allows someone to apply to become the editor for the category they are currently
browsing. The following information is needed
 Name
 Username
 Email
 Examples of three basic listings they want to add to the category they are
applying for (same fields required as for the basic listing submission form).
 Additional comments field (i.e., why do they want to edit for the site)

After editor is accepted to the site by admin, they will be able to login and enter
their Google Adsense publisher ID and Ad Channel name so they can participate
in the revenue share scheme.

Editor will be able to approve / decline / edit new submissions for those categories
they had applied as an editor.

Existing editors will be able to submit an application to edit additional categories

using the editor control panel. This will be a simple process and doesn’t require
examples of listings they want to add.

System will manage editorial guideline to help when user apply to become an
editor.
Software Requirement Specification For Directory Script Project Page 13 of 27

 Meta Editor: A Meta editor is the same as a normal editor, but their additional
job will be to make sure normal editors (that they have been assigned) are
adding listings properly (and following editorial guidelines).

So on top of normal editor functions, Meta editors will be able to view a list of their
editors and see which sites they have approved / edited / rejected. Meta editor is
basically a team lead position for their editors.

Meta editors are basically editors (they have their own categories) who also
supervise other editors. So they receive their “editor” share from their own
categories and their “meta editor” share from categories they supervise.

 User: These are general users who can suggest site for basic or premium
listings related to specific category.

All submissions will have some form of anti spam protection – for example
Captcha image verification. Payments for premium listings will be taken by PayPal
and this will be integrated into the system.

All listings will verify email addresses prior to adding the listing to the “pending”
admin queue.

Note: Besides listing users system will also maintain details of users that report for
a bad listing like URL of category, E-mail address, date of reporting, and their
report

b. Category Management System: This subsystem will manage all the categories and
their sub categories of the online custom directory script.
 Category creation (by Admin): Category Name, Category Description,
Creation Date and Status (Active/Inactive/Delete)
 Edit category details by admin users.
Software Requirement Specification For Directory Script Project Page 14 of 27

 Delete, in this case admin will have the option to move its listings to another
category
 If category names have spaces in them, then the URLs will be rewritten to replace
the space with a hyphen.
 Alphabetical sorting of category to display them on web pages.

c. Listing Management System: General user can add listings for a specified category
using “Suggest a Site” functionality. There will be two type of listing – Premium and
Free.

 System will manage following information for Free listings:

 Site Name
 Site URL
 Short site description (no more than 200 characters)
 Category (Drop down list)
 Email Contact (with anti harvester protection)
 Check box to receive e-mails
 System will manage following information for Premium listings:
 As above mentioned (besides last one), plus:
 An extended description field (up to 1000 characters) – required.
 If someone buys a premium listing, then they chose a primary category. In
that category, their listing appears as a premium result (as explained above).
Then they will be able to select up to 4 secondary categories, where their
listing will appear in the normal results. So for example, Key Solution buys
a listing in “Business > Web Design” – Key Solution listing appears as a
premium result in the “Business > Web Design” category (primary). Key
Solution can also chose “Regional > Asia > India > Business Services” as a
secondary category where Key Solution listing appears as a normal result as
well.
Software Requirement Specification For Directory Script Project Page 15 of 27

 “Key Services” – additional URLs and Titles for the site allow the premium
listing to link directly to services or other pages of the site. Up to 4 of these
can be added.
 Location (text field)
 Telephone
 Username and password (required)
 Date Added

 All listing submissions will have some form of anti spam protection – for example
Captcha image verification. Payments for premium listings will be taken by PayPal
and this will be integrated into the system.
 Premium listing on top category page will be shown recent adverts from all
subcategories.
 All listings will verify email addresses prior to adding the listing to the “pending”
admin queue.
 One listing can have one of following status:
 Under verification  when first time created then email verification will be
pending
 Pending  pending for admin/editor/meta editor user to review of new
listing
 Approved  New listing approved by admin/editor/meta editor
 Reject  New listing rejected by admin/editor/meta editor
 Deleted  By admin user
 ToUpgrade  pending for admin to review when listing user applies to
upgrade. When admin user accept upgrade listing application then type will
change to Premium and status become “Approved”
 ToBadReport  pending for admin to review when bad reporting received. If
admin reject it as bad then status become approved.
 AcceptBad  admin accept listing as bad/spam
Note: Only listing with approved/ToUpgrade/ToBadReport status will be
available for the online custom directory solution.
Software Requirement Specification For Directory Script Project Page 16 of 27

 System will manage history data of listing status that has been done in their life.
 System will manage information about recent premium listing (mostly 4 recent
listings) for their categories.
 When category is going to delete and it’s listing move to other category then its
previous details will be available in database.
 All submissions will automatically email users when the listing is submitted (with
email verification link) and for basic listings, the email will contain information
about the benefits of the premium listing.
 When users use “upgrade this listing” functionality to upgrade basic listings they
will be taken to a page which will allow them to add more information to the listing
related to premium listing, and then take them on to a payment page. This listing
will be then flagged to admin for review to authorise the listing change.

d. Advertisers Management System: This section will be used to manage information

of advertisers (and their listings) who are registered to the system to list their listings
under specified categories.
 System will use registration form when “Suggest a Site” functionality will be used
by advertisers.
 Advertisers full page listing” is a premium listing. Basically, it is a paid for result
that will appear at the top of the list of listed sites. When a user clicks on a
premium listing they don’t go to the site – they are taken to a full page listing that
describes the website with the information outlined on premium listing.

e. Email Management System – E-Mail Management Subsystem will be responsible to

manage various listing events like listing submission, approval and their upgrading.
This subsystem will also be used to e-mail user groups.

 Emails will be sent when:

 A listing is submitted
 A listing is approved or declined
 A listing is upgraded from basic to premium
Software Requirement Specification For Directory Script Project Page 17 of 27

 Also, admin will be able to email user groups:

 Just editors
 Just meta editors
 Just premium advertisers
 Just basic listings
 To all users

f. Content Management System – The Content Management System will allow the
admin user to change/edit the contents of pages
 Admin can edit header and footer of the web pages.
 Admin can Add/Edit instruction for “Suggest a Site” functionality
 Admin user can add/edit editorial guideline for “Become an editor” functionality
 Admin can add/edit “About us” page.
 Add/Edit instruction for “Suggest a Site” page
 Manage editorial guideline to help editor applicant.
 Manage benefits of premium listing

g. Revenue Sharing System – Revenue sharing system will be used to manage

Adsense adverts. System will maintain revenue share ratio for page views that will be
editable by admin user.
 Adsense will be added the following pages:
 All sub category pages
 All premium listing pages
 Adsense will be displayed on top category pages but won’t be part of revenue
sharing system (that is, 100% of pages impressions will be of admin)
 Revenue sharing will work as follows:
 To start with, all Adsense adverts displayed “belong” to admin.
 When a new editor is accepted, their adverts appear within their category a
certain percentage of the time (defined by admin) – the rest of the time,
admin adverts appears.
Software Requirement Specification For Directory Script Project Page 18 of 27

 When a new Meta editor is promoted, their adverts appear in their own
categories (as with editors) – but their adverts also appear in sub categories
managed by editors under their control.
 If an editor is removed, then the adverts in their category revert to admin
only.

h. Reporting System:
 Pending basic listings
 Pending premium listings
 Editor list / Meta editor list (with detailed information about the listings they
approved)
 Approved / Rejected listings list (with details of who approved / rejected them)
 General statistics (how many basic / premium listings / editors / Meta editors / new
listings per day / etc).

2.2 Product Features

Application will provide to manage user, category, listings and content management
system using My SQL database and PHP technology.
 User Management System:-
Key Features: -
 Valid active user can login into the application to submit and/or edit
information.
 Application will work as per logged in user permissions for admin, editor and
Meta editor user groups.

 Category Management System

Key Features:-
 All category pages will have a “suggest a new category” link leads to a form
which the user can fill out.
 If category pages have more than 10 listings, then they will create additional
pages as necessary.
Software Requirement Specification For Directory Script Project Page 19 of 27

 If category names have spaces in them, then the URLs will be rewritten to
replace the space with a hyphen.

 Listing Management System:-

Key Features: -
 Premium listings will be on the top level category pages, but they will display
recent premium listings from sub categories.
 On low level category pages premium listings will always appear first, and
then followed by the normal listings. The premium listings will look different
from the normal listings (for example, Adwords compared to normal Google
results).

 Advertisers Management System

Key Features: -
 System will manage details of advertisers who submit listings in system
existing categories.

 Email Management System

Key Features: -
 All submissions will automatically email users when the listing is submitted
(with email verification link) and for basic listings, the email will contain
information about the benefits of the premium listing.

 Content Management System

Key Features: -
 A basic template will be available to allow the creation of static pages (such
as editor guidelines or “about us” type pages).

 Revenue Sharing System

Key Features: -
Software Requirement Specification For Directory Script Project Page 20 of 27

 Revenue will be share for adverts displayed on low level category pages
among Admin, Editor and Meta Editor users based on revenue share ratio
defined by admin.

 Reporting System
Key Features: -
 System will report basic statistics about editor/meta editor to admin user

2.3 User Classes & Characteristics

 Added later in next version

2.4 Operating Environment

 Software Requirements:
 Operating System : Windows
 Web server : ISAPI
 Web Technology : PHP
 Database technology : MY SQL

 Hardware Requirements:
 Windows 2000, 2003 Server or Windows XP
 Pentium III – 900 MHz
 At least RAM 128MB

2.5 Design & Implementation Constraints

 Network Communication: - Application is client server application so it need

network communication between server and client machine.

2.6 User Documentation

 User Manual
Software Requirement Specification For Directory Script Project Page 21 of 27

2.7 Assumptions & Dependencies

 NA

3. System Features

 URLs will be search engine friendly (no session IDs, no duplicated content
created).
 URLs will be rewritten using ISAPI.
 The site will be 800 pixels wide, with a left hand column for navigation and a right
hand column for additional advertising (130 pixel width minimum).
 Each page will contain breadcrumb navigation.
 A basic template will be available to allow the creation of static pages

4. External Interface Requirements

4.1 User Interfaces:

 General:
 Each page will contain breadcrumb navigation.
 If category names have spaces in them, then the URLs will be rewritten to
replace the space with a hyphen.
 All category pages will have a “suggest a new category” link leads to a form
which the user can fill out.
 If category pages have more than 10 listings, then they will create additional
pages as necessary
 Home Page:
 The homepage for the site will be a standard directory style homepage
(similar to dmoz.org). All main (top level) categories will be listed in
alphabetical order with sub categories listed below them. This will be done
in such a way to maintain a consistent style to the page.
Software Requirement Specification For Directory Script Project Page 22 of 27

 Below the main directory part of the homepage, there will be a list of recent
advertisers. Only recent premium listings will be added to the homepage
and will link to the advertiser’s full page listing within the directory.

 Home Page Key Information:

o Page Title – Wee Boab’s Web Directory
o Meta Keywords – web directory, business directory, website directory,
website listings, internet directory, weeboab, wee boab
o Meta Description – Wee Boab’s website directory is a volunteer edited
website directory listing only quality websites on the web.
o H1 tag - Wee Boab’s Web Directory
o H2 tags – all category names

 Top level category page

 This will be similar to the homepage, listing sub categories each with a short
description
 The recent advertiser’s part of the page will only list advertisers from within
this category.
 The left hand navigation on top level category pages will list all sub
categories in that section, along with the normal “home”, “about us” and
“editor application” links.
 Premium listings will be on the top level category pages, but they will display
recent premium listings from sub categories. So for example, user can’t have
a premium listing in the “Technology” category, but if user paid for a
premium listing in “Technology > Web Design Blogs” then his listing will
appear on the main “Technology” page for a while. It basically only shows
the recent premium adverts from all sub categories.
 Adsense will be displayed on top category pages but it won’t be part of the
revenue share system (that is, 100% of page impressions will be of admin).
 Top Level Category page Key Information:
o Page Title – [category name]
Software Requirement Specification For Directory Script Project Page 23 of 27

o Meta Keywords – [category name], [category name] website listings,

[category name] Internet directory
o Meta Description – [category name] website and business listings
o H1 – Main category name
o H2 tags – breadcrumb navigation
o URL format – www.weeboab.co.uk/category

 Lower Level Category Pages:

 Low level category pages will basically be search results pages, listing all
entries for that category. Premium listings will get priority and will stand out
from normal listings.
 The premium listings will always appear first in low category, and then
followed by the normal listings. The premium listings will look different from
the normal listings (for example, Adwords compared to normal Google
results).
 In addition, free listing will have options: Report a bad listing, Upgrade listing.
Premium listing will have same options along with a “more” information link
which lead to the full page listing for the advertisers.
 Low Level Category page Key Information:
o Page Title – [sub category name] – [top level category name]
o Meta Keywords – [sub category name], [sub category name] website
listings, [sub category name] Internet directory
o Meta Description – [category name] website and business listings
o H1 – Category name
o H2 tags – breadcrumb navigation
o URL format - www.weeboab.co.uk/category/subcategory

 Editor Profile page Key Information

 Page Title – [username]
 Meta Keywords – [username]
Software Requirement Specification For Directory Script Project Page 24 of 27

 Meta Description – Profile page for [username] – WeeBoab.co.uk Editor.

 H1 – [username]
 URL format - www.weeboab.co.uk/profiles/username

 Premium Listing or Advertisers pages key Information

 Page Title – [site title]
 Meta Keywords – [site title]
 Meta Description – Use the short site description
 H1 – Site title
 URL format - www.weeboab.co.uk/listings/sitetitle
Software Requirement Specification For Directory Script Project Page 25 of 27

 Home Page Layout:

Software Requirement Specification For Directory Script Project Page 26 of 27

 Admin Panel Layout:

4.2 Hardware Interfaces

 NA

4.3 Software Interfaces

 NA
Software Requirement Specification For Directory Script Project Page 27 of 27

4.4 Communication Interfaces

 NA

5. Other Nonfunctional Requirements

5.1 Performance Requirements

 Performance of this project will be based on the hardware used.

5.2 Safety Requirements

 All Safety requirements are provided by the client of product.

5.3 Security Requirements

 Mentioned in Quality Attributes

5.4 Software Quality Attributes

 Accessibility: Only authorized user can use the application.

 Reliability: Reliability will depend on the server where the product is hosted.
 Maintainability: This project will be planned as efficiently as possible in a well-
documented modular form so that updates and maintenance in the design or code
can be made easily. The team designs the application in such a way that more
features can be added without interfering with the base product.

6. Other Requirements

 NA