SRS Coffee Machine Tutorial

Francois Salazar

Description

SRS-TEMPLATE SEPTEMBER 30, 2009 1.01 Coffee Machine Requirement Specifications ABSTRACT: This document is a tutorial on requirement writing. The goal is to demonstrate a good practice in requirements management. KEYWORDS: Requirements, Tutorial, SRS, Good Practice APPROVED: AUTHOR PROJECT MANAGER Francois Salazar LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE Coffee Machine Requirement Specifications SRS-TEMPLATE 1.0 Revision History VERSION DATE AUTHOR CHANGE DESCRIPTION th1.0 August 9 , 2004 Francois SALAZAR Initial version LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE Coffee Machine Requirement Specifications SRS-TEMPLATE 1.0 License LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE Coffee Machine Requirement Specifications SRS-TEMPLATE 1.0 Table of Contents 1.1 Purpose ............................................................................................................................. 1 1.2 Scope ................................. 1 1.3 Audience Description ....... 1 1.4 References ......................... 2 1.5 Definitions, Acronyms, and Abbreviations ...................................... 2 1.6 Document Location .......................................................................... 2 1.7 Problem Reporting Instructions ........................................................ 2 2.1 Overview ...................................................... ...

Informations

• Publié par: Endri
• Nombre de lectures: 187
• Langue: English

Extrait

 

SRS-TEMPLATE SEPTEMBER 30, 2009 1.01

Coffee Machine Requirement Specifications

ABSTRACT: This document is a tutorial on requirement writing. The goal is to demonstrate a good practice in requirements management. KEYWORDS: Requirements, Tutorial, SRS, Good Practice APPROVED: AUTHOR Francois Salazar    

 

PROJECT MANAGER      

       

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

Coffee Machine Requirement Specifications

Revision History

VERSION 1.0  

DATE August 9 th , 2004

 

AUTHOR Francois SALAZAR

SRS-TEMPLATE 1.0

CHANGE DESCRIPTION Initial version

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

Coffee Machine Requirement Specifications

License

 

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

SRS-TEMPLATE 1.0

Coffee Machine Requirement Specifications

SRS-TEMPLATE 1.0

Table of Contents 1.1   Purpose .............................................................................................................................1   1.2   Scope. ................................................................................................................................ 1   1.3   Audience Description .......................................................................................................1   1.4   References ......................................................................................................................... 2   1.5   Definitions, Acronyms, and Abbreviations ......................................................................2   1.6   Document Location ..........................................................................................................2   1.7   Problem Reporting Instructions ........................................................................................2   2.1   Overview ........................................................................................................................... 4   2.2   Actors view .......................................................................................................................4   3.1   Overview. .......................................................................................................................... 6   3.2   User Interface Management..............................................................................................7   3.2.1   Introduction ............................................................................................................... 7   3.2.2   Requirements ............................................................................................................7   3.3   Drink Management .........................................................................................................10   3.3.1   Introduction. ............................................................................................................ 10   3.3.2   Requirements ..........................................................................................................10   3.4   Anticipation ....................................................................................................................11   3.4.1   Introduction. ............................................................................................................ 11   3.4.2   Requirements ..........................................................................................................11   3.5   Maintenance. ................................................................................................................... 13   3.5.1   Introduction ............................................................................................................. 13   3.5.2   Requirements ..........................................................................................................13   4.1   Provided Interfaces .........................................................................................................14   4.2   Required Interfaces .........................................................................................................14   5.1   Performance Requirements.............................................................................................15   5.2   Design Constraints..........................................................................................................15   5.3   Safety Requirements .......................................................................................................16   5.4   Security Requirements....................................................................................................16   5.5   Software Quality Attributes ............................................................................................16    

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

Coffee Machine Requirement Specifications

 

SRS-TEMPLATE 1.0

1 Introduction The “Cool Company” wants to provide to its employees a “Break Area” to rest when they are tired. The main goal is to increase the intellectual productivity by proposing a place where they can seat, get a drink and play pinball. This document focuses on one of the subsystems: the “Coffee Machine”.  

This template can be used in multi scale requirements specification. It can be used to describe a tool, a platform, engine software, a component, your swimming pool project, etc… So you have to define clearly the scope and explain which document(s) are ‘upper’ or where do these requirements come from (market study, marketing requirement document, Platform Product Specification…) Think also to the “Black Box” vision. Consider your system (currently defined in this document) as the center of the world and as a black box. This means that you don’t know how it works inside but you have to define what your system does and which actors interacts with it.

  1.1 Purpose   The purpose of this document is to describe the requirements of “Coffee Machine” which is a subpart of the “Break Area” (hall de pause) system. Coffee Machine main objective is to provide to users a drink, cold or hot.   1.2 Scope The scope of this document is the system “Coffee Machine”, subpart of “Break Area” system.   1.3 Audience Description This document shall be known, reviewed, used as a work basis by: - Employee of ‘Cool Company’ for suggestions and approval   - System Engineers for estimation and validation of requirements  Architects for feasibility study and technical solution design -  

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 1

Coffee Machine Requirement Specifications

 

SRS-TEMPLATE 1.0

1.4 References   TITLE REFERENCE VERSION LOCATION [1] The Coffee  1234 1.0 http:// …   Receipe Book [2] IEEE Coffee  6546 5.2 http:// …   Standards   Next table is mandatory. It lists all father documents and justifies the writing of this one. This information will be used to control adherence to this (or these) documents and will be useful for impact analysis. Moreover, traceability will be built on this information.   UPPER REQUIREMENTS REFERENCE VERSION LOCATION [3] Break Area User _ 1.0 tp:// BA SR V ht and System Requirements [4] Break Area BA_SA V1.0 http:// System Architecture 1.5 Definitions, Acronyms, and Abbreviations

TERM/ACRONYM DEFINITION CM Coffee Machine      1.6 Document Location Document Registry: SRS Coffee Machine Tutorial ( Direct Access       1.7 Problem Reporting Instructions Problems or corrections to this document should be reported using the Change Process. Change Request Portal: http://mephisto.sps.mot.com/wsd/platform.html  

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 2

Coffee Machine Requirement Specifications

     

 

Folder/Sub Folder: Break Area _ Technical Domain& Feature: Coffee Machine _ Direct link if in WSD environment:     Submit a CR  

SRS-TEMPLATE 1.0

Give the way to submit CRs on this document and eventually indicates some field’s value. This part is important to readers and developers because with this information, they will know exactly where to submit CRs.

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 3  

Coffee Machine Requirement Specifications

SRS-TEMPLATE 1.0

2 Overall Description 2.1 Overview The Coffee Machine is a subsystem of Break Area system. Itis represented in green color in following context diagram.   In UML, such a diagram is made of ‘entities’, which are abstract representation of subsystems. You don’t need to represent all services but just give the main exchanges between entities if you are at upper system level. When you are in a component Requirement Specification, you can display more services (real signals or function calls). Keep in mind that this overview graphic must be clear and light; it must ‘help’ the reader to understand,not to flood him under tons of details.    

Break  Area  Context package  BreakArea { 1 / 2 }   Weather   Forecast       re CoffeMachine GetWeather   User   quest   a   cof f e                    

GetMoney Alarm AddCof f e

          Seats Pinball   CoffeManager  

  2.2 Actors view   The Coffee Machine will interact with following actors listed below.  

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

  Room

 

• 4

Coffee Machine Requirement Specifications

ACTOR User Coffee Manager Weather Forecast    

 

SRS-TEMPLATE 1.0

DESCRIPTION This actor is a single person, which is tired, and need to seat and drink a coffee. This actor is in charge to manage the coffee machine. His main goals are to ensure the coffee machine is always available and to get the money from the machine every evening. This actor represents the weather forecast information provider. The coffee machine will use it to plan the preparation of cold or hot drinks.

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 5

Coffee Machine Requirement Specifications

3 Functional Requirements

SRS-TEMPLATE 1.0

1. To find requirements, think of the global system use cases(scenarii) and extract your system responsibility, most of the time, an upper Architecture Document will give you the ‘responsibilities’ of your system.   Think about ‘what will external actors expect from my system’ ? Play system use cases and think to clear ambiguity of behaviors.   E.g. The User enters in the break area, requests a coffee by voice order and sits until the coffee is ready (sound signal from coffee machine). => Coffee Machine responsibility is to listen to User request / to prepare a coffee / to signal the coffee is ready   2. Remember to write requirements with appropriate syntax: Identifier, Name (usually think of a service name). Do not declare here ‘internal operations’ The <system> shall…   3. Refer to feature database or your nomenclature to determine requirement naming (ref to Requirement Management Guideline)

  3.1 Overview   This section sums up in the below table the main functionalities provided by the Coffee Machine, which will be detailed in the following sections.   MAIN FUNCTIONS DESCRIPTION ACTORS User Interface  Groups the services in the scope of user interaction. User Management Coffee  Manager Drink Management  All the drink management services and operations  User (choice proposal, selection, preparation … ). Anticipation The  coffee machine embeds anticipation function  User (weather forecast, user preferred drink … ) Weather  Forecast Maintenance Coffee Manager    

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 6   

Coffee Machine Requirement Specifications

SRS-TEMPLATE 1.0

3.2 User Interface Management   3.2.1 Introduction   The Coffee Machine will have to interact with two actors. This section describes the interface services and requirements for this goal. 3.2.2 Requirements  

1. Remember to number your requirements by 10 to 10. It will enable future insertion of requirement without breaking the numbering suite (insert 0015, 0017,etc…). For easy reading, a requirement can have a ‘nickname’ (R-CM-UI-0010 Welcome).   2. The version (incremented each time the requirement is changed after baselining: 1,2,3…) will be useful to measure the ‘volatility’ of requirements, changing a requirement is never free of work and rework. This measure will give hints on the amount of changes, which impacted specifically the requirements.   3. Depending on the system you are defining and the visibility you have, you can add sequence specification to your requirements but with your system as a black box.

      IDENTIFIER VERSION NAME REQUIREMENT TEXT / DATA UPPER LINKS R-CM-UI-0010 2 Welcome  The CoffeeMachine shall welcome any new user  R-BA-CNV-0010 when he is at less than 2 meters of Coffee Machine.   

LICENSE CREATIVE COMMONS / PATERNITÉ-PAS DE MODIFICATION 2.0 FRANCE

• 7