10
Functional Specification Elaboration Phase DSG Functional Specification Template v4.2, June 2008 Enter Project Name Here Software Version <X.Y> Sponsor: Enter sponsor’s name DMDC Lead: Enter lead’s name Prepared By: Enter person’s name Published: Enter date Approved By: Enter person’s name Project Officer: Enter person’s name Customer: Enter customer name here Data Model Review Board: Enter name of approving review board member QA Resource: Enter QA Tester name here Data Dictionary Manager: Enter name of approving data dictionary manager Table of Contents 1.0 Introduction...........................................................1 2.0 Business Context.......................................................1 2.1 Definitions..........................................................1 2.2 Context Models.......................................................1 2.2.1 <business process #1>............................................2 2.2.2 <business process N>.............................................2 3.0 Functional Requirements................................................2 3.1 System Actor-Goal Listing............................................2 3.2 System Use Case Model................................................3 3.3 System Use Case Narratives...........................................3 3.4 Business Rules.......................................................4 3.4.1 <Business Rule Category 1>.......................................4 3.4.2 <Business Rule Category 2>.......................................4 4.0 Non-Functional Requirements............................................4 4.1 Performance Requirements.............................................4 4.2 Monitoring and Logging Requirements..................................4 4.3 Security Requirements................................................5 4.4 Privacy Requirements.................................................5 4.5 Testability Requirements.............................................6 4.6 General Constraints..................................................6 5.0 Future Requirements....................................................6 6.0 Resource Requirements..................................................6 6.1 Human Resource Needs.................................................6 7.0 Revision History.......................................................6 APPENDIX A : <As needed>.................................................... 7 DMDC Functional Specifications - For Official Use Only i

Functional Specifications Template v4.2

Embed Size (px)

Citation preview

Page 1: Functional Specifications Template v4.2

Functional SpecificationElaboration PhaseDSG Functional Specification Template v4.2, June 2008

Enter Project Name HereSoftware Version <X.Y>Sponsor: Enter sponsor’s name DMDC Lead: Enter lead’s name Prepared By: Enter person’s name Published: Enter dateApproved By: Enter person’s name Project Officer: Enter person’s nameCustomer: Enter customer name here Data Model Review Board: Enter name of

approving review board member QA Resource: Enter QA Tester name here Data Dictionary Manager: Enter name of

approving data dictionary manager

Table of Contents

1.0 Introduction...................................................................................................................................... 12.0 Business Context........................................................................................................................... 1

2.1 Definitions.................................................................................................................................... 12.2 Context Models............................................................................................................................ 1

2.2.1 <business process #1>........................................................................................................22.2.2 <business process N>..........................................................................................................2

3.0 Functional Requirements..............................................................................................................23.1 System Actor-Goal Listing............................................................................................................23.2 System Use Case Model.............................................................................................................33.3 System Use Case Narratives.......................................................................................................33.4 Business Rules............................................................................................................................ 4

3.4.1 <Business Rule Category 1>...............................................................................................43.4.2 <Business Rule Category 2>...............................................................................................4

4.0 Non-Functional Requirements......................................................................................................44.1 Performance Requirements.........................................................................................................44.2 Monitoring and Logging Requirements........................................................................................44.3 Security Requirements................................................................................................................. 54.4 Privacy Requirements.................................................................................................................. 54.5 Testability Requirements.............................................................................................................64.6 General Constraints..................................................................................................................... 6

5.0 Future Requirements..................................................................................................................... 66.0 Resource Requirements................................................................................................................6

6.1 Human Resource Needs..............................................................................................................67.0 Revision History............................................................................................................................. 6APPENDIX A : <As needed>....................................................................................................................... 7

To update the Table of Contents, click in the table then press F9

DMDC Functional Specifications - For Official Use Only i

Page 2: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

1.0 IntroductionThe introduction should give a summary of the system for which this functional specification is being written. This summary may include as little or as much detail as necessary, but should describe the purpose and approach of the system while also providing background and/or history where appropriate.>

2.0 Business ContextThe business context section should describe the system as it relates to business processes and other systems.

2.1 DefinitionsBusiness definitions go here

Term1 - <Definition>

TermN - <Definition>

2.2 Context Models<The business context models should depict the each of the different business contexts in which the system may operate>

DMDC Functional Specifications - For Official Use Only Page 1

Page 3: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

2.2.1 <business process #1>

<followed by paragraph description>2.2.2 <business process N>

<UML activity diagram goes here><followed by paragraph description>

3.0 Functional Requirements<The functional requirements section should detail the functionality or behaviors provided through the system>

3.1 System Actor-Goal ListingThe following table depicts the system’s primary actors and their goals in using the system.

Actor Goal Description

3.2 System Use Case ModelThe following use case diagram depicts the high-level functionality of <System>. Details on each of the specific uses are captured in the following use case narratives (Section 3.3) and business rules (Section 3.4)

DMDC Functional Specifications - For Official Use Only Page 2

Page 4: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

3.3 System Use Case NarrativesThe following use case narratives provide details on each of the specific uses of the system:

UC1. <Use Case Name>Description: < In one or two sentences, describe the interaction that occurs in this use case. Try not to regurgitate the basic course of events, rather summarize the events, actors, and goals, providing context not included in other sections.>Assumptions

<Description of assumption 1> <Description of assumption 2>

Basic Course of Action1. <First step in the Basic Course of Action> (See Alternate Actions A & B)2. <Next Step> (See Business Rule BR2)

Alternate Course of Action A (<Summary description of Action A>)A1.<First step in Alternate Course of Action A>A2.<Next Step>

Alternate Course of Action B (<Summary description of Action B>)B1.<First step in Alternate Course of Action B>B2.<Next Step>

3.4 Business Rules<The business rules section should contain details specific to the business for which the system is being built. These rules are used to supplement the system behavior described in the use cases. For example, the system may provide the ability to record a sale, and may have associated business rules that define the sales data to be captured and how to calculate the sales tax.>

DMDC Functional Specifications - For Official Use Only Page 3

Page 5: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

3.4.1 <Business Rule Category 1>

BR1BR.1.1 <Business rule text goes here>BR.1.2 <Business rule text goes here>

<List item1> <List item 2>

3.4.2 <Business Rule Category 2>

BR2BR.2.1 <Business rule text goes here>BR.2.2 <Business rule text goes here>

<List item1> <List item 2>

4.0 Non-Functional Requirements<While functional requirements address specific functionality or behaviors provided by the system, non-functional requirements (sometimes referred to as “technical requirements” or “technical constraints”) are criteria or constraints of these functions or behaviors. For example, we may have functional requirement that states the system will print a receipt for all sales. The associated non-functional requirements might address the speed with which that receipt must print and might also require that we log the sale item, amount, and time for audit purposes.>

4.1 Performance RequirementsP.1 <How many transactions at peak?>P.2 <Throughput?>

4.2 Monitoring and Logging RequirementsM.1 <Monitor and Logging Requirements>M.2

4.3 Security RequirementsSecurity Requirements Yes No N/A4.3.1 Does proposed project include COTS Products?4.3.1.1 Are they security products or security enabled products?4.3.2 Does proposed project include only standard ports?4.3.2.1 If not, please identify the ports the product uses.4.3.3 Does proposed project include hashing or encryption?4.3.4 Will the application display a Privacy Act Statement?4.3.5 Is there a valid or legal reason to display the Social Security Number?4.3.6 Is there a valid or legal reason for not requiring CAC/PIN login?

DMDC Functional Specifications - For Official Use Only Page 4

Page 6: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

4.4 Privacy RequirementsPersonally Identifiable Information (PII) is any form of information that can be used to identify, locate, or contact an individual. This information includes, but is not limited to SSN, name, home address/phone number, complete DOB, personal medical information, financial information, religion, or national origin.

There are also indirect identifiers, which when used in combination, could help to narrow down the identity of a specific individual. This information includes, but is not limited to gender, age, race, geographic indicators, and job position.Privacy Requirements Yes No UnknownIf any question is answered Yes or Unknown, see the DMDC Privacy Information Officer.4.4.1 Is Privacy Act data to be displayed?4.4.2 Will the application collect, maintain, or disseminate information in identifiable form?4.4.3 Will this application change anonymous information into information in identifiable form?4.4.4 Will this application change how information in identifiable form is managed?4.4.5. Will this application alter a business process that results in significant new uses or disclosures of information?4.4.6. Will this application alter a business process that will incorporate additional information items in identifiable form?4.4.7 If new information in identifiable form is added to a collection, will this application raise the risks to personal privacy?4.4.8 Based on all of Section 4.4 questions is a PIA (Privacy Impact Assessment) required?

4.5 Testability RequirementsT.1 <As needed>T.2

4.6 General ConstraintsC1 <As needed>C2

5.0 Future RequirementsF.1 <As needed>

6.0 Resource Requirements

DMDC Functional Specifications - For Official Use Only Page 5

Page 7: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

6.1 Human Resource Needs

Define the human resource needs. Complete the table as well as possible.

Need Resource Amount Status CommentsProject Officer N hours

Requirements/Design N hours

Technical Expert N hours

Systems Architect N hours

Database Administrator N hours

Development N hours

QA Testing N hours

Configuration Management

N hours

Production Support N hours

Technical Writer

DSC

Systems

7.0 Revision History

Revision Revised By Date

DMDC Functional Specifications - For Official Use Only Page 6

Page 8: Functional Specifications Template v4.2

Functional SpecificationElaboration Phase

APPENDIX A: <As needed>

DMDC Functional Specifications - For Official Use Only Page 7