Requirement Specification Document

Requirement Specification

System Name

12/3/2002

Table of Contents
TABLE OF CONTENTS............................................................................................. - 2 1.0 INTRODUCTION......................................ERROR! BOOKMARK NOT DEFINED. 1.1. 1.2 1.3 1.3.1 1.3.2 1.3.3 1.3.4 1.3.5 1.3.6 1.3.7 1.4 1.5 1.6 2.1 2.2 2.3 2.4 2.5 2.6 2.7 3.1 3.2 3.3 3.4 3.5 3.6 3.7 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 PURPOSE ......................................................... ERROR! BOOKMARK NOT DEFINED. BACKGROUND & OVERVIEW ......................... ERROR! BOOKMARK NOT DEFINED. GOALS OF THE SYSTEM ................................. ERROR! BOOKMARK NOT DEFINED. MAINTAIN USER ACCOUNTS .................... ERROR! BOOKMARK NOT DEFINED. MAINTAIN CUSTOMER ACCOUNTS .................................................................... 4 MAINTAIN SERVICE TRANSACTION ................................................................... 4 BILL CUSTOMERS .............................................................................................. 4 MONITOR USAGE OF FACILITY STORAGE RESOURCES ....................................... 4 MAINTAIN FACILITY SERVICES .......................................................................... 4 MAINTAIN CUSTOMER SERVICES ....................................................................... 4 OUTSTANDING ISSUES ........................................................................................... 4 APPROVALS ........................................................................................................... 5 PROJECT LEVEL STANDARDS ................................................................................. 5 ELEMENTS ..................................................... ERROR! BOOKMARK NOT DEFINED. SYSTEM CUSTOMERS ..................................... ERROR! BOOKMARK NOT DEFINED. SYSTEM EXTERNAL INTERFACES .................... ERROR! BOOKMARK NOT DEFINED. OBJECTIVES ................................................... ERROR! BOOKMARK NOT DEFINED. CONSTRAINTS ................................................. ERROR! BOOKMARK NOT DEFINED. ASSUMPTIONS ......................................................................................................... 5 SYSTEM ARCHITECTURE ......................................................................................... 6 KEY AREAS OF FUNCTIONALITY .................... ERROR! BOOKMARK NOT DEFINED. HUMAN INTERFACE ....................................... ERROR! BOOKMARK NOT DEFINED. DISPLAY AND OPERATOR/USER INTEFACE .... ERROR! BOOKMARK NOT DEFINED. APPLICATION DEVELOPMEMT ENVIRONEMENT ..................................................... 7 SOFTWARE ............................................................................................................. 7 DATABASE AND DATA MANAGEMENT .................................................................. 7 ACCESSIBILITY FACTORS ....................................................................................... 8 INTRODUCTION .............................................. ERROR! BOOKMARK NOT DEFINED. GENERAL ....................................................... ERROR! BOOKMARK NOT DEFINED. SUB SYSTEM FUNCTIONALITY........................ ERROR! BOOKMARK NOT DEFINED. BUSINESS OR DOMAIN RULES OR INPUT VALIDATION RULES ................................ 7 PROCESSING .......................................................................................................... 7 REPORTING ............................................................................................................ 7 DISPLAYS AND OPERATOR ALERTS/USER MESSAGES ........................................... 8 PERFORMANCE ...................................................................................................... 8 RESOURCE MANAGEMENT ..................................................................................... 8

2.0 PROJECT AND SYSTEM ........................ERROR! BOOKMARK NOT DEFINED.

3.0 GENERAL REQUIREMENTS ................ERROR! BOOKMARK NOT DEFINED.

4.0 SUB SYSTEM REQUIREMENTS...........ERROR! BOOKMARK NOT DEFINED.

-2-

Requirement Specification 4.10 FAULT MANAGEMENT

System Name

12/3/2002

5.0 SERVER AND SYSTEM OPERATIONS ..................ERROR! BOOKMARK NOT DEFINED. 5.1 5.2 INTRODUCTION ............................................. ERROR! BOOKMARK NOT DEFINED. SYSTEM MANAGEMENT AND DISASTER RECOVERY ..... ERROR! BOOKMARK NOT DEFINED.

6.0 DATA DICTIONARY ...............................ERROR! BOOKMARK NOT DEFINED.

-3-

Requirement Specification

System Name

12/3/2002

Requirements Specification
1.
1.1.

Introduction
Purpose

This specification is intended to provide the environmental and software functional requirements for the <project name> system being developed by Organization for <court or agency name>. Describe the purpose of the new system. Describe why the development effort is being undertaken.

Describe what operational, agency or mission benefits are expected to be gained by implementation of this system. 1.2. Background and Overview

Describe the current legacy or manual system and environment. (Can be taken from the Project Management Plan) 1.3. Goals of the System

There are a number of goals that the system must satisfy to enable users of the system to perform their jobs. Underneath each of these goals are supporting functions required to facilitate these goals. 1.3.1. Maintain User Accounts Add User Account Update User Information View User Information Delete User Information

1.3.2. Maintain Customer Accounts Add Customer Account Update User Information View User Information Delete User Information

-4-

Requirement Specification

System Name

12/3/2002

1.3.3. Maintain Service Transactions 1.3.4. Add Service Transactions Update Service Transactions View Service Transactions Delete Service Transactions Bill Customers View Records for Customers Create Bills Submit Bills

1.3.5. Monitor Usage of Facility Storage Resources (Future Requirement Release 2.0 or later) View Inventory of Entire Facility Create Inventory Reports View Available Inventory Space Predict Future Inventory Availability Build Reports of Unbilled Services

1.3.6. Maintain Facility Services (the total set of available services) View Facility Services Add Facility Services Update Facility Services Delete Facility Services

1.3.7. Maintain Customer Services Add Facility Services Update Facility Services View Facility Services Delete Facility Services

1.4.

Outstanding Issues

None (unless otherwise specified) 1.5.

Approvals List the names and position/role of any individuals/organizations who must approve of this specification before beginning work on the Software Functional Requirements Specification. -5-

Requirement Specification

System Name

12/3/2002

1.6

Project Level Standards

List any project-wide industry or customer standards or protocols that are required by this project. This section should simply be repeated from the Project Management Plan section on standards.

2.
2.1.

<project name> Project and System

<project name> Elements

Describe the major components of the project System Users

2.2.

List or characterize the type and nature of end-user community for which this system is being developed. 2.3. System External Interfaces

Describe any external interfaces or organizations or systems that will affect or be affected by the development and deployment of this system. 2.4. Objectives

Describe the objectives (probably take this section from the Sys. Ops & Concept Specification) of this project. What improvements, benefits key mission capabilities is this system intended to provide. 2.5. Constraints

Describe any organizational, security, project, and technological or other constraints under which this system must be developed or subject to. 2.6. Assumptions

List and describe any key assumptions about the project, system, technology, users, organization or any other types of assumptions about the system and the development effort.

-6-

Requirement Specification

System Name

12/3/2002

2.7.

System Architecture

Describe the system architecture/environment at a high level. Is it client-server, web-centric, intranet, standalone, batch processing, rule-based system, neural net, etc. What are the key elements of the architecture, COTS software, database, data warehouse, etc.

-7-

Requirement Specification

System Name

12/3/2002

3.

General Requirements

This section describes system requirements of a general nature that is, requirements that affect the entire system or have system wide applicability. 3.1. Key Areas of Functionality

Describe the key functionality that will be provided by the system. Human Interface

3.2.

This section describes at a high level, the required menu structures, screen/window designs, report layouts and other interfaces to operators and/or supervisors. At this stage, the requirements may be broad or relate to existing standards or products. 3.3. Displays and Operator/User Interface

Describe the types and nature of the displays that will characterise this sub-system. Application Development Environment

3.4.

This section shall specify the components of the system that are available to the customer for use in developing applications. It should contain at a minimum the data types and languages or application generators that are available. 3.5. Software

These requirements may include some of the following: Operating System Database Communications Interfaces.

3.6.

Database and Data Management

Describe the major database entities that would interact with or support this subsystem.

-8-

Requirement Specification

System Name

12/3/2002

Describe any specific or general kinds or categories of data management that will be performed by this sub-system. 3.7. Accessibility Factors

Describe any aspects of the system that are critical to its usability such as screen readers for graphical images in browsers. <ALT> text tags for images for blind or vision impaired users. Audio prompts for hearing impaired users etc. Describe any conformance requirements with requirements such as the Americans with Disabilities Act.

Determine whether the section 508 of the Federal Accessibility Standards for Electronic Information Technology applies. A copy of this information has been included in the appendices for reference in case it is applicable.

-9-

Requirement Specification

System Name

12/3/2002

4. Sub-System Requirements Repeat this section as necessary for each module or sub-system
4.1. Introduction

Describe the role that this sub-system plays. General

4.2.

TBD Sub-System Functionality

4.3.

Describe specific functionality/services/features repeat this section as necessary Business or Domain Rules or Input Validation Rules

4.4.

Describe or characterise the types of business or domain rules or rule-sets that will be implemented in this sub-system. 4.5. Processing

Describe the type of processing that will take place within this sub-system. (e.g. reports, communications monitoring, voice data processing, specific algorithms, trajectory computations, address lookups etc.) 4.6. Reporting

Describe any reporting output that will be generated by this sub-system. Displays and Operator Alerts/User Messages

4.7.

Describe any critical or significant types or categories of operator messages that will be generated by this sub-system.

4.8.

Performance

Describe any aspects or characteristics of performance that this sub-system will be required to meet. - 10 -

Requirement Specification

System Name

12/3/2002

4.9.

Resource Management

Describe any resources that this sub-system will manage or be responsible for controlling or maintaining. (e.g. data repositories, image libraries, archives, etc.) 4.10. Fault Management Describe any specific or significant fault or error recovery and management features or characteristics of this sub-system.

- 11 -

Requirement Specification

System Name

12/3/2002

5.
5.1.

Server and System Operations

Introduction

Provide a general description of the nature and types of operations for which the system will be used and the physical or organizational environment. 5.2. System Management and Disaster Recovery

Describe any processes or personnel responsible for maintenance and operation of the system, database, security, network or other aspects of the system such as backup, recovery, and archiving.

- 12 -

Requirement Specification

System Name

12/3/2002

6.

Data Dictionary

<repeat this table structure for each of the primary tables in the system> <table name> (table) <table description>
Primary Key (PK) Auto Number <field 1> <field 2> <field n> <description> <description> <description>

Examples: Service Transaction (table)

This table contains records of service transactions performed. The transactions are linked to specific customers by the SiteNo. Only one record per day per service can exist in the database for a given customer, but if a customer has 5 different services performed on the same day, then there will be 5 service transaction records in the database for that customer. TransactionID Unique counter assigned automatically by the Primary database. Key (PK) SiteNo The number of the site (std. site no.) which is used to identify the customer for whom the services were performed. Description Brief description or note about the transaction QuantityType Indicates the unit of measure identifying the quantity used (e.g. hours) in one transaction. Quantity The amount of the service units that were used in one transaction. ServiceID The code number of the service provided. UnitPrice The price for one unit of the service. (e.g. dollars or cents)

Customers (table)
This table contains all customers for which services are provided. The table acts as a customer profile which lists all of the services used by a particular customer. There is one record in the table for each service provided for each customer. If a customer has 10 services that they subscribe to or use, then there will be 10 records in the customer table. Every time a service is no longer used or is added to the customers list of services, the corresponding record is added or deleted from this table. CustomerID Unique counter assigned automatically by the Primary database. Key (PK)

- 13 -

Requirement Specification
SiteNo ServiceCode ServiceRate

System Name

12/3/2002

The number of the site (std. site no.) which is used to identify the customer for whom the services were performed. Look-up code in the Services table The rate charged to the customer for one unit of this service. (e.g. $20 per hour)

Services (table)
This table contains all of the services that are available for customers to use. ServiceID Unique counter assigned automatically by the Primary database. Key (PK) ServiceCode A unique code identifying the service. Description Description of the service. ServiceRate The standard rate charged to the customer for one unit of this service. (e.g. $20 per hour) Many customers will not use this rate because different rates are charged to different customers for the same service.

Users (table)
This table contains all of the individual user accounts and their permission levels. UserID Unique counter assigned automatically by the Primary database. Key (PK) UserName The name of the user. Password The password for the user. Type The type of the user. (R Regular User, A Administrative User with full Sys. Admin. Capabilities)

- 14 -