external interface req

8/15/2019 External Interface Req

1/17

SYSTEMS AND SOFTWARE REQUIREMENTSSPECIFICATION (SSRS) TEMPLATE

Version A.1, Se!e"#er $%%&

FOREWORD

This document was written to provide software development projects with a template forgenerating a System and Software Requirements Specification (SSRS). This document is basedon a template originally written by the U.S. avy Research! "evelopment! Test and #valuation"ivision in $une %&&' in accordance with the *+ST"+,&- "" ("+S/+-%,00). Thetemplate was updated by the University of daho1s /enter for Secure and "ependable Systems(/S"S) in $une 233- to adhere to ### Std. -03+%&&-! IEEE Recommended Practice for

Software Requirements Specifications%! and ### Std. %223'+233-! Systems and Software Engineering – Software Life Cycle Processes2. t was then adapted in September 233- for use inU /S 0-0.

The SSRS template begins on the ne4t page. $ust throw away this page and enter your projectspecifications into the following template. "on1t forget to change the headers and footers asnecessary.

DOCUMENT CONVENTIONS

5 Te4t 6 Replace this te4t with your project specification te4t.

text in italics otes or instructions to the author. "elete in final format.

1 ### Std. -03+%&&-! Recommended Practice for Software Requirements Specifications! nstitute of

#lectrical and #lectronics #ngineers! 0,7 #ast ,' th St. ew 8or9! 8! US:! %33%'+20&,.2

S;


2/17

University of daho /S "epartment nstructional Use ;T >;R R#*#:S#

SYSTEMS AND SOFTWARE REQUIREMENTSSPECIFICATION (SSRS) FOR

'inser! or ro*e+! n"e-

're+e i"/e #o0e i!2 +ooer o/o-

Version ''inser! 0ersion n"#er--

''inser! 3!e--

Prere3 4or5

'inser! +o"n n"e, 33ress, n3 +on!+! in4o-

Prere3 #5'inser! or n"e(s)-Uni0ersi! o4 I32o

Mos+o, ID &6&7781%1%

SSRS age 2


3/17


'inser! or ro*e+! n"e- SSRS

RECORD OF C9AN:ES

/hangenumber

"atecomplete

d

*ocation of change(e.g.! page or figure ?)

AMD @rief description of change

:pproved by (initials)

"ate:pproved

AA + :""#" M + ;">#" D + "#*#T#"

SSRS age 3


4/17


'INSERT YOUR PRO;ECT NAME- SSRSTAT;S! :/R;8S! :" :@@R#B:T;S.................................................................................'%.7 R#>#R#/#S...................................................................... ....... ....... ........ ....... ....... ....... ........ ....... ....... ........ .. -%.C ;B#RB#D :" R#STR/T;S......................................... ....... ........ ....... ....... ........ ....... ....... ....... ........ ..... -

2. OVERALL DESCRIPTION....................................................................................................................................9

2.% R;"U/T #RS#/TB#......................................... ....... ....... ........ ....... ....... ....... ........ ....... ....... ........ ....... .... &2.2 R;"U/T >U/T;S.................................................... ........ ....... ....... ....... ........ ....... ....... ........ ....... ....... .... &2.0 US#R /=:R:/T#RST/S............................................................. ........ ....... ....... ........ ....... ....... ....... ........ .... &2., /;STR:TS.............................................................................................................................................. &2.7 :SSUT;S :" "##"#/#S......................................................................................................%3

2.C S8ST# *#B#* (;+>U/T;:*) R#EUR##TS........................................................................%32.6.1 Site dependencies............................................................................................................................................10

2.6.2 Safety, security and privacy requirements......................................................................................................10

2.6.3 Performance requirements..............................................................................................................................10

2.6.4 System and software quality...........................................................................................................................11

2.6.5 Packaging and delivery requirements.............................................................................................................11

2.6.6 Personnel-related requirements.......................................................................................................................11

2.6.7 Training-related requirements.........................................................................................................................12

2.6.8 Logistics-related requirements........................................................................................................................12

2.6.9 Other requirements..........................................................................................................................................12

2.6.10 Precedence and criticality of requirements...................................................................................................12

3. SPECIFIC REQUIREMENTS..............................................................................................................................13

0.% #FT#R:* T#R>:/# R#EUR##TS...............................................................................................%03.1.1 Hardware Interfaces........................................................................................................................................13

3.1.2 Software Interfaces.........................................................................................................................................13

3.1.3 User Interfaces................................................................................................................................................13

3.1.4 Other Communication Interfaces....................................................................................................................13

0.2 S8ST# >#:TUR#S....................................................... ........ ....... ....... ........ ....... ....... ....... ........ ....... ....... .... %C

3.2.1 System feature 1: [ insert feature name here ]................................................................................................16

3.2.2 System feature 2: [ insert feature name here ]................................................................................................17

3.2.3 System feature [m]: [ insert feature name here ]............................................................................................17

4. REQUIREMENTS TRACEABILITY.................................................................................................................19

5. APPENDIX A. [INSERT NAME HERE]...........................................................................................................20

6. APPENDIX B. [INSERT NAME HERE]............................................................................................................21

SSRS age 4


5/17


1. 1. INTRODUCTION

Tis section te document sould introduce te pro!ect" customer" audience" etc#" witout del$ing into toomuc detail" %ecause tose details are pro$ided in su%sequent sections#

1.1 IDENTIFICATIONTis paragrap sall contain a full identification of te system and te software to wic tis documentapplies" including" as applica%le" identification num%er&s'" title&s'" a%%re$iation&s'" $ersion num%er&s'"and release num%er&s'#

The software system being considered for development is referred to as 5 insert name and or idnumber 6. The customer providing specifications for the system is 5 insert name and contactinfo 6. The ultimate customer! or end+user! of the system will be 5insert name and contact info6.This is a 5 new G redesign 6 project effort! so the version under development is version 5 insertversion and release number 6.

1.$ PURPOSE

Tis paragrap sall contain a %rief statement on te purpose of te system and software %eing

de$eloped" and te intended audience for tis document#

The purpose of the system under development is to 5 insert your te4t here 6. Dhile the system will be used by 5 insert intended users 6! this document is intended to be read and understood by U/Ssoftware designers and coders. 5 ;ptionalH The document will also be vetted or approved by5 insert approval people 66.

1.6 SCOPE

Tis paragrap sall %riefly summari(e te istory of system de$elopment" operation" and maintenance)identify te pro!ect sponsor" acquirer" user" de$eloper" and support agencies) identify current and planned operating sites) and list oter rele$ant documents#

5 insert your te4t here 6

1.7 DEFINITIONS, ACRONYMS, AND A


6/17


1.= REFERENCES

Tis section sall list full %i%liograpic citations of all documents referenced in tis report# Tis section sall also identify te source for all materials not a$aila%le in printed form &e#g#" we%+%asedinformation' and list te complete ,RL along wit owner" autor" posting date" and date last $isited#

5 insert your citations here 6

1.> OVERVIEW AND RESTRICTIONS

Tis paragrap sall descri%e te organi(ation of tis document and sall descri%e any security or pri$acy considerations associated wit its use#

This document is for limited release only to U /S personnel wor9ing on the project and 5 stateothers who will receive the document 6.

Section 2 of this document describes the system under development from a holistic point of view.>unctions! characteristics! constraints! assumptions! dependencies! and overall requirements aredefined from the system+level perspective.

Section 0 of this document describes the specific requirements of the system being developed.

nterfaces! features! and specific requirements are enumerated and described to a degree sufficientfor a 9nowledgeable designer or coder to begin crafting an architectural solution to the proposedsystem.

Section , provides the requirements traceability information for the project. #ach feature of thesystem is inde4ed by the SSRS requirement number and lin9ed to its S"" and test references.

Sections 7 and up are appendices including original information and communications used tocreate this document.

SSRS age 6


7/17


$. OVERALL DESCRIPTION

Tis section of te document sould descri%e te general factors tat affect te product and itsrequirements# Tis section does not state specific requirements# Instead" it pro$ides te%ac-ground for tose requirements" wic are defined in detail in Section .#

$.1 PRODUCT PERSPECTIVE

Tis su%section of te document sould put te product into perspecti$e wit oter related products# If te product is independent and totally self+contained" it sould %e so stated ere# Ifte document de/nes a product tat is a component of a larger system" ten tis su%section sould relate te requirements of tat larger system to functionality of te software and souldidentify interfaces %etween tat system and te software# * %loc- diagram sowing te ma!orcomponents of te larger system" interconnections" and external interfaces can %e elpful#


$.$ PRODUCT FUNCTIONS

Tis su%section of te document sould pro$ide a summary of te ma!or functions tat te software will perform# 0or te sa-e of clarity Te functions sould %e organi(ed in a way tatma-es te list of functions understanda%le to te customer or to anyone else reading tedocument for te first time# Textual or grapical metods can %e used to sow te different functions and teir relationsips# Suc a diagram is not intended to sow a design of a product"%ut simply sows te logical relationsips among $aria%les#


$.6 USER C9ARACTERISTICS

Tis su%section of te document sould descri%e tose general caracteristics of te intendedusers of te product including educational le$el" experience" and tecnical expertise# It souldnot %e used to state speci/c requirements" %ut rater sould pro$ide te reasons wy certain speci/c requirements are later speci/ed in Section . of tis document#


$.7 CONSTRAINTS

Tis su%section of te document sould pro$ide a general description of any oter items tat will limit te de$eloper1s options# Tese include a' Regulatory policies) %' 3ardware limitations&e#g#" signal timing requirements') c' Interfaces to oter applications) d' Parallel operation) e' *udit functions) f' Control functions) g' 3iger+order language requirements) ' Signalandsa-e protocols) i' Relia%ility requirements) !' Criticality of te application) -' Safety and security considerations#


$.= ASSUMPTIONS AND DEPENDENCIES

Tis su%section of te document sould list eac of te factors tat affect te requirements stated in te document# Tese factors are not design constraints on te system and4or software %ut are"rater" any canges to tem tat can affect te requirements in te document# 0or example" anassumption may %e tat a speci/c operating system will %e a$aila%le on te ardware designated for te software product# If" in fact" te operating system is not a$aila%le" te document wouldten a$e to cange accordingly#

SSRS age 7


8/17



$.> SYSTEM LEVEL (NON8FUNCTIONAL) REQUIREMENTS

Tis su%section of te document sould identify system le$el &wole" not functional'requirements tat impact te construction" operation" pac-aging and deli$ery of te system and software#

$.>.1 Si!e 3een3en+ies

Tis paragrap sall specify site+dependent operational parameters and needs &suc as parameters indicating operation+dependent targeting constants or data recording'# # Terequirements sall include" as applica%le" num%er of eac type of equipment" type" si(e" capacity"and oter required caracteristics of processors" memory" input4output de$ices" auxiliary storage" communications4 networ- equipment" and oter required equipment or software tatmust %e used %y" or incorporated into" te system# Examples include operating systems"data%ase management systems" communications4 networ- software" utility software" input andequipment simulators" test software" and manufacturing software# Te correct nomenclature"$ersion" and documentation references of eac suc de$ice or software item sall %e pro$ided#


$.>.$ S4e!, se+ri! n3 ri0+ re?ire"en!s

Tis paragrap sall specify te system requirements" if any" concerned wit maintaining safety" security and pri$acy# Tese requirements sall include" as applica%le" te safety" security and pri$acy en$ironment in wic te system must operate" te type and degree of security or pri$acyto %e pro$ided" and te criteria tat must %e met for safety4security4pri$acy certification and4oraccreditation#


$.>.6 Per4or"n+e re?ire"en!s

Tis paragrap sould specify %ot te static and te dynamic numerical performance

requirements placed on te soft ware or on uman interaction as a wole# Static numericalrequirements may include te following a' Te num%er of terminals to %e supported) %' Tenum%er of simultaneous users to %e supported) c' *mount and type of information to %e andled# 5ynamic numerical requirements may include" for example" te num%ers of transactions andtas-s and te amount of data to %e processed witin certain time periods for %ot normal and pea- wor-load conditions# *ll of tese requirements sould %e stated in measura%le terms# 0orexample" 6789 of te transactions sall %e processed in less tan :msec#;


$.>.7 Ss!e" n3 so4!re ?i!

Tis paragrap sall specify te requirements" if any" concerned wit ardware and softwarequality factors identified in te contract# Examples include quantitati$e requirements regarding

te system1s functionality &te a%ility to perform all required functions'" relia%ility &te a%ility to perform wit correct" consistent results'" maintaina%ility &te a%ility to %e easily corrected'"a$aila%ility &te a%ility to %e accessed and operated wen needed'" flexi%ility &te a%ility to %eeasily adapted to canging requirements'" porta%ility &te a%ility to %e easily modified for a newen$ironment'" reusa%ility &te a%ility to %e used in multiple applications'" testa%ility &te a%ilityto %e easily and torougly tested'" usa%ility &te a%ility to %e easily learned and used'" andoter attri%utes#


SSRS age 8


9/17


$.>.= P+@/in/ n3 3ei0er re?ire"en!s

Tis paragrap sall specify te requirements" if any" for pac-aging" la%eling" andling anddeli$ery of te system %eing de$eloped to te customer#

The e4ecutable system and all associated documentation (i.e.! SSRS! S""! code listing! test plan(data and results)! and user manual) will be delivered to the customer on /"1s and.> Personne8re!e3 re?ire"en!s

Tis paragrap sall specify te system requirements" if any" included to accommodate tenum%er" s-ill le$els" duty cycles" training needs" or oter information a%out te personnel wowill use or support te system under de$elopment# Tese requirements sall include" asapplica%le" considerations for te capa%ilities and limitations of umans) foreseea%le umanerrors under %ot normal and extreme conditions) and specific areas were te effects of umanerror would %e particularly serious# Examples include requirements for color and duration oferror messages" pysical placement of critical indicators or -eys" and use of auditory signals#

The system under development has no special personnel+related characteristics.

$.>. Trinin/8re!e3 re?ire"en!s

Tis paragrap sall specify te system requirements" if any" pertaining to training# Examplesinclude training software" tutorials" or elp information to %e included in te system#

o training materials or e4pectations are tied to this project other than the limited help screens built into the software and the accompanying user manual.

$.>.& Lo/is!i+s8re!e3 re?ire"en!s

Tis paragrap sall specify te system requirements" if any" concerned wit logisticsconsiderations# Tese considerations may include system maintenance" software support" system transportation modes" supply+system requirements" impact on existing facilities" and

impact on existing equipment#5 nsert a description of the minimum hardware requirements and ;S and application softwaredependencies here 6

$.>.B O!2er re?ire"en!s

Tis paragrap sall specify additional system le$el requirements" if any" not co$ered in te pre$ious paragraps#


$.>.1% Pre+e3en+e n3 +ri!i+i! o4 re?ire"en!s

Tis paragrap sall specify" if applica%le" te order of precedence" criticality" or assignedweigts indicating te relati$e importance of te requirements in tis specification# Examplesinclude identifying tose requirements deemed critical to safety" to security" or to pri$acy for purposes of singling tem out for special treatment# If all requirements a$e equal weigt" tis paragrap sall so state#


SSRS age 9


10/17


6. SPECIFIC REQUIREMENTS

Tis section of te document sould contain all of te software requirements to a le$el of detail sufficient to ena%le designers to design a system to satisfy tose requirements" and testers to testtat te system satisfies tose requirements# Trougout tis section" e$ery stated requirement

sould %e externally percei$a%le %y users" operators" or oter external systems# Teserequirements sould include at a minimum a description of e$ery input into te system" e$eryoutput from te system" and all functions performed %y te system in response to an input or in support of an output# *s tis is often te largest and most important part of te document" allrequirements sould %e uniquely identifia%le and careful attention sould %e gi$en to organi(ingte requirements to maximi(e reada%ility#

6.1 ETERNAL INTERFACE REQUIREMENTS

Tis su%section sould %e a detailed description of all inputs into and outputs from te software system# It sould complement te constraints and dependencies defined in earlier sections" %utnot repeat tat information# 3ardware" software" user" and oter communication interfaces need

to %e specified# ,se te four su%sections listed %elow or te ta%le on te next page" or somecom%ination of %ot#

SSRS age 10


11/17


6.1.1 9r3re In!er4+es

The hardware interfaces will largely revolve around the graphical capabilities of the system. :smost modern graphics processors will be able to operate effectively at the required %&23K%3-3resolution! a monitor or other =" device will be required. Thought the siLe of this device willvary! it must be capable of supporting %&23K%3-3 natively.

;ther hardware will include standard / devicesH mouse! 9eyboard! and some type of storagedevice for saving games and game states. Selection and play of games will be through use of amouse or other standard pointing device! perhaps in conjunction with the 9eyboard to ease theaccommodation of multiple players.

The use of other pointing devices such as Diimotes may improve game play in several situations! but would require additional hardware M specifically a @luetooth interface by which Diimotes canconnect.

6.1.$ So4!re In!er4+es

The Table is required to run on a *inu4 based computer. The *inu4 to be used will not require afull installation and will be able to be scaled down to provide those applications or services thatwill be required for gaming with the Table.

Name information will be stored in data files which will contain listings of rules! and the variousobjects that are to be used during game play (images for the game board! cards! dice! etc.).

>iles of a similar format will be used to store game information so a game in progress can behalted and returned to as the user desires.

6.1.6 User In!er4+es

The user will interact with the Table via a NU! which will limit the need for a 9eyboard. Nameselection will be facilitated by menus! with other functions (downloading new content! managinggames and related files) also utiliLing a simple menu system.

Name play will feature visual cues as to which player1s turn Storage of games and game states onthe local hard drive or other storage device will be handled by calls to the ;S which manages thefile system.

:t any time a user will be able to get help by clic9ing on a persistent icon. Dhile this will offersome information on the use of the Table! it will largely be focused on the rules of the specificgame being played.

6.1.7 O!2er Co""ni+!ion In!er4+esThe table will feature a networ9 interface by which a user will be able to update their game libraryas needed. /ommunication will be via =TT or >T to a server that contains a list of games andthe associated UR*s for obtaining them.

SSRS age 11


12/17


E!ern In!er4+e Re?ire"en!s

9r3re In!er4+es

N"e Sor+eDes!in!ion Des+ri!ion Tern/e Deen3en+ies For"!s

So4!re In!er4+es


User In!er4+es


O!2er Co""ni+!ion In!er4+esN"e Sor+eDes!in!ion Des+ri!ion Tern/e Deen3en+ies For"!s

SSRS age 12


13/17


6.$ SYSTEM FEATURES

0unctional requirements sould define te fundamental actions &i#e#" features' tat must ta-e place in te software in accepting and processing te inputs and in processing and generatingte outputs# Tese requirements are gi$en in te form of Use Cases were possi%le" denoting aconcrete use &discrete user+performa%le tas-' of te system# ,se case diagrams are followed %yuse case descriptions" followed %y any non+tas- features#


14/17


6.$.> Ss!e" 4e!re $5 ' inser! 4e!re n"e 2ere -

6.$.>.1 In!ro3+!ionProse o4 !2is 4e!re5 insert your te4t here 6

6.$.>.$ In!O!! se?en+e 4or !2is 4e!re5 insert your te4t here 6

6.$.>.6 Desi/n +ons!rin!s o4 !2is 4e!re5 insert your te4t here 6

6.$.>.7 Per4or"n+e re?ire"en!s o4 !2is 4e!re5 insert your te4t here 6

6.$.>.= De!ie3 4n+!ion re?ire"en!s o4 !2is 4e!re

6.$.>.=.1 Fn+!ion re?ire"en! $.15 insert your te4t here 6

6.$.>.=.$ Fn+!ion re?ire"en! $.$5 insert your te4t here 6

6.$.>.=.6 Fn+!ion re?ire"en! $.'n-5 insert your te4t here 6

6.$. Ss!e" 4e!re '"-5 ' inser! 4e!re n"e 2ere -

6.$..1 In!ro3+!ionProse o4 !2is 4e!re5 insert your te4t here 6

6.$..$ In!O!! se?en+e 4or !2is 4e!re

5 insert your te4t here 66.$..6 Desi/n +ons!rin!s o4 !2is 4e!re5 insert your te4t here 6

6.$..7 Per4or"n+e re?ire"en!s o4 !2is 4e!re5 insert your te4t here 6

6.$..= De!ie3 4n+!ion re?ire"en!s o4 !2is 4e!re

6.$..=.1 Fn+!ion re?ire"en! '"-.15 insert your te4t here 6

6.$..=.$ Fn+!ion re?ire"en! '"-.$5 insert your te4t here 6

6.$..=.6 Fn+!ion re?ire"en! '".n-5 insert your te4t here 6

SSRS age 14


15/17


7. REQUIREMENTS TRACEA


16/17


=. APPENDI A. 'INSERT NAME 9ERE-

Include copies of specifications" moc-ups" prototypes" etc# supplied or deri$ed from te customer# *ppendices are la%eled *" @" =n# Reference eac appendix as appropriate in te text of te

document#5 insert appendi4 : here 6

SSRS age 16


17/17


>. APPENDI

external interface req

Documents