Volere Specification Template v6

8/8/2019 Volere Specification Template v6

1/51


2/51


3/51


4/51


5/51


6/51


7/51

Volere Template V6.1 Copyright Atlantic Systems Guild 7This template may be copied for internal use provided copyright is acknowledged

that they will be extremely displeased if this requirement is not satisfactorilyimplementedThe point of having a satisfaction and a dissatisfaction rating is that it guidesyour clients to think of the requirement from two different perspectives, andhelps you to uncover what they care about most deeply.

DDDDeeeeppppeeeennnnddddeeeennnncccciiiieeeessss

This keeps track of other requirements that have an impact on thisrequirement.If the dependency exists because requirements use the same information,then use of standard naming conventions and definitions (see Section 5) willimplement this dependency.Other dependencies exist because a solution to this requirement has apositive or negative effect on solutions to other requirements. Capture thesetypes of dependencies by cross referencing the requirements.Some requirements, especially project drivers and project constraints, have

an impact on all the other requirements.CCCCoooonnnnfffflllliiiiccccttttssss

This keeps track of other requirements that disagree with this one. Conflictsthat are caused by mistake are solved simply by bringing them to the surfaceand resolving them. Other conflicts are because of true differences inopinion/ intention. These are the conflicts that might eventually need to beaddressed using negotiation or mediation techniques. There is nothing wrongwith having conflicting requirements providing you know that you have them.Then you are in a position to address the conflict.

HHHHiiiissssttttoooorrrryyyyWe follow the requirement from the date that it was created, through all i tschanges. We minimise future confusion by recording the rationale for makingmajor changes. When a requirement is deleted we record when and therationale behind the deletion. The date that the requirement passes itsquality checks, and who passed it, is also recorded.

DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss uuuusssseeeedddd iiiinnnn tttthhhhiiiissss tttteeeemmmmppppllllaaaatttteeee

Context of the ProductThe boundaries between the product that we intend to build and the people,organisations, other products and pieces of technology that have a directinterface with the product.


8/51


Context of the WorkThe subject matter, people and organisations that might have an impact onthe requirements for the product. The context of study identi fies theintersection of all the domains of interest.

ClientThe person or organisation for whom the product is being built, usuallyresponsible for paying for the development of the product.

CustomerThe person or organisation who will buy the product (note that the sameperson/ organisation might play both the client, customer and sometimes userroles)

Design or Systems DesignCrafting a solution to fi t the requirements.

DevelopersThe people who specify and build the product.

Domain of InterestA subject matter area that has some relevance to the context of study.

Non-Functional RequirementA property that the eventual product must have.

EventWe use the term business event to mean a business related happening withina system adjacent to the work that we are studying. The happening causesthe work to produce an event-response.

Fit CriterionObjective measure for defining the meaning of a requirement, and eventuallytesting whether a given solution satisfies the original requirement.

Functional RequirementAn action that the product must be able to take, something that the productmust do.

Global Constraint

Constraints that apply to the system as a whole.Product

This is what we are attempting to deliver. This could be a piece of software,the installation of a package, a set of procedures, a piece of hardware, apiece of machinery, a new organization, or almost anything.


9/51


RequirementA measurable statement of intent about something that the product must do,or a property that the product must have, or a constraint on the system.

StakeholderA stakeholder is a person who can affect the outcome/ success of the projectand/ or is affected by its outcome/ success.

SystemThe business system whose requirements are being studied.

Systems AnalysisDetailed study of the requirements, intended to prove their workabili ty asinput to systems design.

Use caseWe use the term event-driven use case (or product use case) to mean a user-defined (or actor defined) piece of activity within the context of the product.

User or End UserSomeone who has some kind of direct interface with the product.


10/51


1111 TTTThhhheeee PPPPuuuurrrrppppoooosssseeee ooooffff tttthhhheeee PPPPrrrroooodddduuuucccctttt

1111aaaa.... TTTThhhheeee uuuusssseeeerrrr pppprrrroooobbbblllleeeemmmm oooorrrr bbbbaaaacccckkkkggggrrrroooouuuunnnndddd ttttoooo tttthhhheeee pppprrrroooo jj j jeeeecccctttt eeeeffffffffoooorrrrtttt....Content

A short description of the work context and the situation that triggered thedevelopment effort. It should also describe the work that the user wants todo with the delivered product.

MotivationWithout this statement, the project lacks justification and direction.

ConsiderationsYou should consider whether or not the user problem is serious, and whetherand why it needs to be solved.

1111bbbb.... GGGGooooaaaallllssss ooooffff tttthhhheeee pppprrrroooodddduuuucccctttt....Content

This boils down to one, or at most a few, sentences that say What do wewant this product for? In other words, the real reason that the product isbeing developed.

MotivationThere is a real danger of this purpose getting lost along the way. As thedevelopment effort heats up, and the customer and developers discover more

and more what is possible, it may well be that the system as it is beingconstructed wanders away from the original goals. This is a bad thing unlessthere is some deliberate act by the client to change the goals. It may benecessary to appoint a person to be custodian of the goals, but it isprobably sufficient to make the goals public, and periodically remind thedevelopers of i t. It should be mandatory to acknowledge the goals at everyreview session.

ExamplesWe want to give immediate and complete response to customers ordering

our goods over the telephone.We want to be able to forecast the weather.Fit Criterion

An objective measure that will enable testing to determine if the goal hasbeen met by the product.


11/51


2222 CCCClllliiiieeeennnntttt,,,, CCCCuuuussssttttoooommmmeeeerrrr aaaannnndddd ooootttthhhheeeerrrr SSSSttttaaaakkkkeeeehhhhoooollllddddeeeerrrrssss

2222aaaa.... TTTThhhheeee cccclllliiiieeeennnntttt iiiissss tttthhhheeee ppppeeeerrrrssssoooonnnn // / / ssss ppppaaaayyyyiiiinnnngggg ffffoooorrrr tttthhhheeee ddddeeeevvvveeeellllooooppppmmmmeeeennnntttt,,,, aaaannnndddd oooowwwwnnnneeeerrrr ooooffff tttthhhheeeeddddeeeelllliiiivvvveeeerrrreeeedddd ssssyyyysssstttteeeemmmm....

ContentThis item must give the name of the client. It is permissible to have severalnames, but more than three negates the point.

MotivationThe client has the final acceptance of the system, and thus must be satisfiedwith the system as delivered. Where the system is being developed for in-house consumption, the roles of the client and the customer may be filled bythe same person. If you cannot find a name for your client, then perhaps youshould not be building the product.

ConsiderationsSometimes, when building a package or a product for external users, the

client is the marketing department. In this case, a person from the marketingdepartment must be named as the client.

2222bbbb.... TTTThhhheeee ccccuuuussssttttoooommmmeeeerrrr iiiissss tttthhhheeee ppppeeeerrrrssssoooonnnn // / / ssss wwwwhhhhoooo wwwwiiiillllllll bbbbuuuuyyyy tttthhhheeee pppprrrroooodddduuuucccctttt ffffrrrroooommmm tttthhhheeee cccclllliiiieeeennnntttt....Content

The name of the person who plays the role of the customer for the product.In the case of in house development the roles of the client and the customerare often played by the same person. In the case of the development of amass market product there may be several people playing the role ofcustomer. In the case of a product that is being developed for aninternational market, there might be a different customer (or customerprofile) in each country.

MotivationThe customer role is ultimately responsible for deciding whether or not tobuy the product from the client. The product must be built to satisfy the aimsof the customer/ s whilst conforming to the constraints of the client. Even ifthe customer/ s are people who work for another part of the clientsorganization, they might still have the authority to decide whether or not toinvest budget in the new product.

2222cccc.... OOOOtttthhhheeeerrrr ssssttttaaaakkkkeeeehhhhoooollllddddeeeerrrrssssContent

The roles and (if possible) names of other people and organizations who areaffected by the product or whose input is needed in order to build theproduct.


12/51


Examples of stakeholders include:Users (detailed in section 3)SponsorTestersBusiness AnalystsTechnology Experts

System DesignersMarketing ExpertsLegal ExpertsDomain ExpertsUsability ExpertsRepresentatives of external associationsFor each type of stakeholder identify:

Stakeholder Identification (some combination of role/ job tit le,person name, organisation name), Knowledge needed by the project, Necessary degree of involvement for that stakeholder/ knowledge

combination, Degree of influence for that stakeholder/ knowledge combination, Agreement on how to address conflict between stakeholders who

have an interest in the same knowledge

MotivationFailure to recognize stakeholders results in missing requirements.

3333 UUUUsssseeeerrrrssss ooooffff tttthhhheeee PPPPrrrroooodddduuuucccctttt

3333aaaa.... TTTThhhheeee uuuusssseeeerrrrssss ooooffff tttthhhheeee pppprrrroooodddduuuuccccttttContent

A list of the potential users of the product. For each category of user, providethe following information:User name This is most likely to be the name of a user group like:schoolchildren, road engineers, project managers.User role Summarizes the users responsibilities.


13/51


Subject matter experience Summarizes the users knowledge of thebusiness. Rate as novice, journeyman or master.Technological experience this describes the users experience withrelevant technology. Rate as novice, journeyman or master.Other user characteristics Describe any characteristics of the users thathave an effect on the requirements and eventual design of the product.Describe things like:

Physical abil it ies/ disabili tiesIntellectual abili ties/ disabilitiesAtti tude to jobAttitude to technologyEducationLinguistic skillsAge group

GenderMotivation

Users are human beings who interface with the product in some way. Therole of the client is to pay for the development of the product and the role ofthe customer is to buy the product. The role of the user is to use the productto do work. You use the characteristics of the users to define the usabilityrequirements for the product.

ExamplesUsers can come from wide, and sometimes unexpected, sources. Considerthe possibility of your users being clerical staff, shop workers, managers,highly-trained operators, general public, casual users, passers-by, illit eratepeople, tradesmen, students, test engineers, foreigners, children, lawyers,remote users, people using the system over the telephone or Internetconnection, emergency workers, and so on.

3333bbbb.... TTTThhhheeee pppprrrriiiioooorrrriiiittttiiiieeeessss aaaassssssssiiiiggggnnnneeeedddd ttttoooo uuuusssseeeerrrrssssContent

Attach to each category of user a priority rating. This gives the importance

and precedence of the user. Prioritize the users into:Key users. These are critical to the continued success of the product.

Give greater importance to requirements generated by thiscategory of user.

Secondary users. They will use the product, but their opinion of it hasno effect on its long-term success. Where there is a conflict


14/51


between secondary users requirements and those of key users thekey users take precedence.

Unimportant users. This category of user is given the lowest priority.It includes infrequent, unauthorized and unskilled users, andpeople who misuse the product.

Percentage of this type of user this is intended to assess the amount ofconsideration given to this category of user.

MotivationIf some users are considered to be more important to the product, or theorganization, then this should be stated because it should affect the way thatyou design the product. For instance, you need to know if there is a largecustomer who has specifically asked for the product, and if they do not getwhat they want then the results could be a significant loss of business.Some users may be listed as having no impact on the product. This meansthat the users will make use of the product, but have no vested interest in it.In other words, these users will not complain, nor will they contr ibute. Any

special requirements from these users will have a lower design priority.3333cccc.... UUUUsssseeeerrrr ppppaaaarrrrttttiiiicccciiiippppaaaattttiiiioooonnnn

ContentWhere appropriate attach to the category of user, a statement of theparticipation that you think will be necessary to provide the requirements.Describe the contribution that you expect this user to provide businessknowledge, interface prototyping, usability requirements etc. If possible,assess the minimum amount of time that this user must spend for you to beable to determine the complete requirements.

MotivationMany projects fail through lack of user participation, sometimes this isbecause the required degree of participation was not made clear. Whenpeople have to make a choice between getting their everyday work done andworking on a new project, the everyday work takes priority. This requirementmakes it clear, from the outset, that specified user resources must beallocated to the project.


15/51


4444 MMMMaaaannnnddddaaaatttteeeedddd CCCCoooonnnnssssttttrrrraaaaiiiinnnnttttssss

TTTThhhhiiiissss sssseeeeccccttttiiiioooonnnn ddddeeeessssccccrrrriiiibbbbeeeessss ccccoooonnnnssssttttrrrraaaaiiiinnnnttttssss oooonnnn tttthhhheeee rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss aaaannnndddd tttthhhheeee eeeevvvveeeennnnttttuuuuaaaallll ddddeeeessssiiiiggggnnnnooooffff tttthhhheeee pppprrrroooodddduuuucccctttt....

4444aaaa.... SSSSoooolllluuuuttttiiiioooonnnn ccccoooonnnnssssttttrrrraaaaiiiinnnnttttssssContent

This specifies constraints on the way that the problem must be solved. Youcan think of these as mandated solutions. Carefully describe the mandatedtechnology, include the appropriate version numbers, and a measurement ofhow you will test compliance. If possible, you should also explain the reasonfor using the technology.

MotivationTo identi fy constraints that must be part of the final product. Your client,customer or user may have design preferences. If these are not met thenyour solution is not acceptable.

ExamplesThe product must use the current 2-way radio system to communicate withthe drivers in their trucks.The product must use the Windows NT operating system.The product must be a hand-held device.

ConsiderationsWe want to define the boundaries within which we can solve the problem.Be careful because anyone who has experience/ exposure to a piece oftechnology tends to see requirements in terms of that technology. Thistendency leads people to impose solution constraints for the wrong reasonand its very easy for untrue constraints to creep into a specification. If youimpose untrue constraints the danger is that you do not have the creativefreedom to come up with the best solution to the problem. The solutionconstraints should only be those that are absolutely non-negotiable. In otherwords, however you solve this problem you must use this particulartechnology. Any other solution would be unacceptable.

4444bbbb.... IIIImmmmpppplllleeeemmmmeeeennnnttttaaaattttiiiioooonnnn eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnnttttContent

This describes the technological and physical environment in which theproduct will be installed. This includes automated, mechanical,organizational and other devices. These include the non-human adjacentsystems.


16/51


MotivationTo describe the technological environment into which the product must fit.The environment places design constraints on the product. This part of thespecification provides enough information about the environment for thedesigners to make the product successfully interact with its surroundingtechnology.The operational requirements are derived from this description.

ExamplesThis can be shown as a diagram, with some kind of icon to represent eachseparate device or person (processor). Draw arrows to identify the interfacesbetween the processors and annotate them with their form and content .

ConsiderationsAll the component parts of the current system, regardless of their type,should be included in the description of the implementation environment.If the product is to affect, or be important to the current organization,include an organization chart.

4444cccc.... PPPPaaaarrrrttttnnnneeeerrrr aaaapppppppplllliiiiccccaaaattttiiiioooonnnnssssContent

This describes applications that are not part of the product but with whichthe product will collaborate. These can be external applications, commercialpackages or pre-existing in-house applications.

MotivationTo provide information about design constraints that are caused by using

partner applications. By describing or modeling these partner applications,you discover and highlight potential problems of integration.Examples

This section can be completed by including written descriptions, models orreferences to other specifications. The descriptions must include a fullspecification of all interfaces that will have an effect on the product.

ConsiderationsExamine the work context model to determine if any of the adjacent systemsshould be treated as partner applications. It might also be necessary toexamine some of the details of the work to discover relevant partnerapplications.


17/51


4444dddd.... CCCCoooommmmmmmmeeeerrrrcccciiiiaaaallll ooooffffffff tttthhhheeee sssshhhheeeellllffff ppppaaaacccckkkkaaaaggggeeeessssContent

This describes applications that must be used to implement some of therequirements for the product.

MotivationTo identify and describe existing commercial products that must beincorporated into the eventual product. The characteristics, behavior andinterfaces of the package are design constraints.

ExamplesThis section can be completed by including written descriptions, models orreferences to vendors specifications.

ConsiderationsThe use of a specific package has been mandated. When gatheringrequirements you may discover requirements that are in serious conflict withthe behavior and characteristics of the package. Keep in mind that the use of

the package was mandated before the full extent of the requirements wasknown. In light of your discoveries you must consider whether the package isa viable choice when all the requirements are known. If the use of thepackage is not negotiable, then the conflicting requirements will have to bediscarded.

4444eeee.... AAAAnnnnttttiiiicccciiiippppaaaatttteeeedddd wwwwoooorrrrkkkkppppllllaaaacccceeee eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnnttttContent

This describes the workplace in which the users will work and use theproduct. This should describe any features of the workplace that could havean effect on the design of the product.

MotivationTo identi fy characteristics of the physical workplace so that the product isdesigned to compensate for any difficulties.

ExamplesThe printer is a considerable distance from the users desk. This constraintsuggests that printed output should be de-emphasized.The workplace is noisy, so audible signals might not work.The workplace is outside so the product must be waterproof, have displaysthat are visible in sunlight and allow for the effect of wind on any paperoutput.The user will be standing up or working in positions where he must hold theproduct. This suggests a hand-held product but only a careful study of the


18/51


users work and workplace will provide the necessary input to identi fying theoperational requirements.

ConsiderationsThe physical work environment constrains the way that work is done. Theproduct should overcome whatever difficulties exist, however you mightconsider a redesign of the workplace as an alternative to having the productcompensate for it.

4444ffff.... HHHHoooowwww lllloooonnnngggg ddddoooo tttthhhheeee ddddeeeevvvveeeellllooooppppeeeerrrrssss hhhhaaaavvvveeee ttttoooo bbbbuuuuiiiilllldddd tttthhhheeee ssssyyyysssstttteeeemmmm????Content

Any known deadlines, or windows of opportunity, should be stated here.Motivation

To identify critical times and dates that have an effect on productrequirements. If the deadline is short, then the requirements must be kept towhatever can be built within the time allowed.

ExamplesTo meet scheduled software releases.There may be other parts of the business or other software products that aredependent on this product.Windows of marketing opportunity.Scheduled changes to the business that will use your product. For examplethe organization may be starting up a new factory and your product isneeded before production can commence.

ConsiderationsState deadline limitations that exist by stating the date and describing why itis critical. Also identi fy prior dates where parts of your product need to beavailable for testing.You should also ask questions about the impact of not meeting the deadlinelike:What happens if we dont build the system by ......?What is the financial impact of not having, the system by?

4444gggg.... WWWWhhhhaaaatttt iiiissss tttthhhheeee ffffiiiinnnnaaaannnncccciiiiaaaallll bbbbuuuuddddggggeeeetttt ffffoooorrrr tttthhhheeee ssssyyyysssstttteeeemmmm????Content

The budget for the system, expressed in money or available resources.Motivation

The requirements must not exceed the budget. This may constrain thenumber of requirements that can be included in the product.


19/51


The intention of this question is to determine if the product is really wanted.Considerations

Is it realistic to build a product within this budget? If the answer to thisquestion is no, then either the client is not really committed to building theproduct or does not place enough value on the product. In either case youshould consider whether it is worthwhile continuing.

5555 NNNNaaaammmmiiiinnnngggg CCCCoooonnnnvvvveeeennnnttttiiiioooonnnnssss aaaannnndddd DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss

TTTThhhhiiiissss sssseeeeccccttttiiiioooonnnn ggggiiiivvvveeeessss ddddeeeeffffiiiinnnniiiittttiiiioooonnnnssss ooooffff aaaallllllll tttteeeerrrrmmmmssss,,,, iiiinnnncccclllluuuuddddiiiinnnngggg aaaaccccrrrroooonnnnyyyymmmmssss,,,, uuuusssseeeedddd iiiinnnn tttthhhheeeepppprrrroooo jj j jeeeecccctttt....

ContentA dictionary containing the meaning of all the names used within therequirements specification. Select names carefully to avoid giving a different,

unintended meaning.This dictionary should build on the standard names that your organization, orindustry, uses. The names should also reflect the terminology in current usewithin the work area.The dictionary contains all important names that are used by the project. Foreach name write a succinct definition. This definition must be agreed by theappropriate stakeholders.

MotivationNames are very important. They invoke meanings that, if carefully defined,can save hours of explanations. Attention to names at this stage of theproject helps to highlight misunderstandings.The dictionary produced during requirements is used and added tothroughout the project.

ExamplesGritter Truck -- a truck used for spreading de-icing substances on roads inwinter.

ConsiderationsMake use of existing references and data dictionaries. Obviously it is best toavoid renaming existing items unless they are so ambiguous that they causeconfusion.From the start of the project emphasise the need to avoid homonyms andsynonyms and explain how they increase the cost of the project.


20/51


Later on, as the analysis progresses, this description will be expanded todefine all the elementary terms that describe a gri tter truck.Gritter Truck = Truck Registration Number, Truck Capacity,

Truck Service StatusAs we progress through the requirements specification each of theelementary terms will be defined in detailTruck Capacity - the number of tonnes of grit that can be carried by a truck.From 0.5 to 2 tonnes

6666 RRRReeeelllleeeevvvvaaaannnntttt FFFFaaaaccccttttssss aaaannnndddd AAAAssssssssuuuummmmppppttttiiiioooonnnnssss

6666aaaa....EEEExxxxtttteeeerrrrnnnnaaaallll ffffaaaaccccttttoooorrrrssss tttthhhhaaaatttt hhhhaaaavvvveeee aaaannnn eeeeffffffffeeeecccctttt oooonnnn tttthhhheeee pppprrrroooodddduuuucccctttt,,,, bbbbuuuutttt aaaarrrreeee nnnnooootttt mmmmaaaannnnddddaaaatttteeeeddddrrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss ccccoooonnnnssssttttrrrraaaaiiiinnnnttttssss....

ContentStatements describing other forces, systems, activities in the world that havean effect on this system.

MotivationRelevant facts might contribute to requirements. They will have an effect onthe eventual design of the product.

ExamplesOne ton of de-icing material will treat 3 miles of single lane roadway.The existing application is 10,000 lines of C code.

6666bbbb.... AAAAssssssssuuuummmmppppttttiiiioooonnnnssss tttthhhhaaaatttt tttthhhheeee tttteeeeaaaammmm aaaarrrreeee mmmmaaaakkkkiiiinnnngggg aaaabbbboooouuuutttt tttthhhheeee pppprrrroooo jj j jeeeeccccttttContent

A list of the assumptions that the developers are making. These might beabout the intended operational environment, but can be about anything thathas an effect on the product.

MotivationTo make people declare the assumptions that they are making. Also to make

everyone on the project aware of assumptions that have been made.Examples

Assumptions about new laws or political decisions.Assumptions about what your developers expect to be ready in time for themto use. For example, other parts of your products, the completion of otherprojects, software tools, software components, etc.


21/51


Assumptions about the technological environment in which the product willoperate. These assumptions should highlight areas of expected compatibi li ty.The software components that will be available to the developers.Other products being developed at the same time as this one.Availability and capability of bought-in components.Dependencies on computer systems or people external to this project

ConsiderationsWe often make unconscious assumptions. It is necessary to talk to themembers of the project team to discover any unconscious assumptions thatthey have made. Ask stakeholders (both technical and business-related)questions like What software tools are you expecting to be available, willthere be any new software products, are you expecting to use a currentproduct in a new way, are there any business changes you are assuming wewill be able to deal with....? It is important to state these assumptions upfront. You might also consider the probability of whether or not theassumption is correct, and where relevant, a list of alternatives if somethingthat is assumed does not happen.

7777 TTTThhhheeee SSSSccccooooppppeeee ooooffff tttthhhheeee WWWWoooorrrrkkkk

7777aaaa.... TTTThhhheeee ccccoooonnnntttteeeexxxxtttt ooooffff tttthhhheeee wwwwoooorrrrkkkk....Content

The work context diagram identi fies the work that we need to investigate inorder to be able to build the product. Note that this includes more than theintended product. Unless we understand the work that the product willsupport, there is little chance of building a product that will fit cleanly intoits environment.The adjacent systems on the example context diagram e.g.Weat her Forecast ing Bureau , indicate other subject matter domains (systems,people and organizations) that need to be understood. The interfacesbetween the adjacent systems and the work context indicate why we areinterested in the adjacent system. In the case ofWeat her Forecast ing Bureau , we can say that we are interested in the details of when, how,where, who and why they produce theDist rict Weat her Forecast information.

MotivationTo clearly define the boundaries for the work study and requirements effort.Without this definition, there is little chance of building a product that willfit seamlessly into its environment.


22/51


Examples

Road De-icing

Work Cont ext

. 0

Weat her St at ions Weat her

Forecast ing Bureau

Truck Depot s Road

Engineering

Thermal Map

Suppliers Weat her Station Readings

Dist rict Weat her

Forecast s

Treat ed Road

Truck Change

Road De icing

Schedule

New Weat her St at ion

Changed Weat her St ation

Changed Road

Amended De icing

Schedule

Unt reat ed Road

Reminder

Thermal Maps

Truck Breakdown

Failed Weat her St ation

Alert

ConsiderationsThe names used on the context diagram should be consistent with thenaming conventions discussed in section 5.

7777bbbb.... WWWWoooorrrrkkkk ppppaaaarrrrttttiiiittttiiiioooonnnniiiinnnnggggContent

An event list, identifying all the business events to which the work responds.The business events are user-defined. The response to each event representsa portion of work that contributes to the total functionality of the work.

The event list includes:Event NameInput from other systems (identical with name on context diagram)Output from other systems (identical with name on context diagram)


23/51


Internal objects/ enti ties that are connected to this business event. Forexample, both events 8 and 9 would be connected to an internal objectcalled road. In other words there is a need within the context toremember information about roads and that information is relevant toevents 8 and 9 (and many other events as well). It is this identificationof common internal objects that provides a link between events.

Motivation

To identify logical chunks of the system that can be used as the basis fordiscovering detailed requirements. These business events also provide thesubsystems that can be used as the basis for managing detailed analysis anddesign.

Example

EEEEvvvveeeennnntttt LLLLiiiisssstttt

EEEEvvvveeeennnntttt NNNNaaaammmmeeee IIIInnnnppppuuuutttt &&&&OOOOuuuuttttppppuuuutttt1. Weat her St at ion t ransmit s reading Weat her St at ion Readings (in)

2 . Weat her Bureau forecas ts weat her Dis t r ict weat her Forecas t ( in)3. Road engineers advise changed roads Changed Road (in)4. Road Engineering inst alls new weat her station

New Weat her St at ion (in)

5. Road Engineering changes weat her st at ion Changed Weat her St at ion (in)6 . Time t o t est Weat her St a t ions Failed Weat her St a t ion Alert ( out )7. Truck Depot changes a t ruck Truck Change (in)

Amended De-icing Schedule (out )

8 . Time t o det ect icy roads Road De-icing Schedule (out )9 . Truck t reat s a road Treat ed Road (in)10 Truck Depot report s problem wit h t ruck Truck Breakdown (in)

Amended Grit t ing Schedule (out )11. Time t o monit or road grit t ing Unt r eat ed Road Reminder (out )

ConsiderationsAttempting to list the business events is a way of testing the work context.This activity uncovers uncertainty and misunderstanding about the projectand helps with precise communications.


24/51


8888 TTTThhhheeee SSSSccccooooppppeeee ooooffff tttthhhheeee PPPPrrrroooodddduuuucccctttt

8888aaaa PPPPrrrroooodddduuuucccctttt BBBBoooouuuunnnnddddaaaarrrryyyyUse case diagram identifies boundaries between the users and product.

Highways Depart ment Clerk

Updat e Weat her Forecast

Monit or Unt reat ed Roads

Record Treat ed

Roads Produce De-icing Schedule

Record Truck Changes

Amend

De-icing Schedule

Truck Depot Engineer

Ident ify Fault y Weat her St at ion

Record New Weat her St at ion

Road Engineering Comput er

Weat her St at ion

Record Road Changes

Record Weat her St at ion Readings

Record Weat her St at ion Changes

Thermal Mapping Dat abase

1

2

3 4

5

6

7

8

9

10

11

You derive the product use cases by deciding where the product boundaryshould be for each one of the business events. These decisions are based onyour knowledge of the work and the requirements constraints.


25/51


8888bbbb UUUUsssseeee ccccaaaasssseeee lllliiiissssttttThe use case diagram is a graphical way of summarizing all the use casesrelevant to the product. If you have a large number of use cases, we find 15-20, is around the limit, then it is better to list the use cases and model eachone individually. For each use case on the list you should have: use casenumber, user/ actor name, use case description and use case fit cri terion.Also if you have built a use case description and/ or any scenario models forthis use case then this list can point to them.

Use Case 8

User/actor nameTruck Depot Engineer

DescriptionProduce road de-icing schedule

Fit Criterion

Sensor readings shall be used to prepare a schedule for the de-icing trucks.Use Case ScenariosThe description for this use case describes the normal way that it operates.Scenario models 8.1, 8.2, 8.3 illustrate exception cases for this use case.

Each of the individual requirements that relates to this use case willcontribute to meeting the fit criterion of the use case. Each individualrequirement will also have its own detailed fit criterion.

9999 FFFFuuuunnnnccccttttiiiioooonnnnaaaallll aaaannnndddd DDDDaaaattttaaaa RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

9999aaaa.... FFFFuuuunnnnccccttttiiiioooonnnnaaaallll RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss....Content

A specification for each individual functional requirement. As with all typesof requirements, use theRequirements Shell.A full explanation is includedin this templates introductory material.

MotivationTo specify the detailed functional requirements that must be supported bythe system.


26/51


Examples

9

The product shall record all t he roads that have been t reated

To be able to schedule unt reated roads and highlight potent ial danger

Arnold Snow - Chief EngineerThe recorded treated roads shall agree wit h the driversroad treatmentlogs and shall be up to date wit hin 30 minutes of t he complet ion of theroads treatment

All r equirement s using road andscheduling data

Work context diagram, termsdef init ions in section 5

Created Februar y 29,2000

75 7, 9

3 5

105

Descript ion:

Rat ionale:

Source:Fit Crit erion:

Cust omer Sat isfact ion:

Dependencies:

Support ing Mat erials:

Hist ory: Copyright At lantic Syst ems Guild

Requirement #: Event /use case #:

Cust omer Dissat isfact ion:

Conflict s:

Volere

Requirement Type:

Fit CriterionEach functional requirement must have a fit criterion. The fit criteriondepends on the required action. For example, if the requirement is to recordsome data, then the fit criterion would say that the data must be able to beretrieved and must match certain standards. For calculations, the resultingdata must conform to predicted results.

ConsiderationsIf you have produced an event/ use case list (see 7b & 8a) you can use themto help you trigger the functional requirements for each event/ use case. Ifyou have not produced an event/ use case list, give each functionalrequirement a unique number and, to help with traceabili ty, they can bepartit ioned into event/ use case-related groups later in the developmentprocess.

9999bbbb.... DDDDaaaattttaaaa rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss....Content

A specification of the essential subject matter/ businessobjects/ entities/ classes that are germane to the system. This might take theform of a first-cut data model, an object model or a domain model. Or itmight be adequately dealt with by defining the terms in the dictionarydescribed in section 5. We have included examples of 2 notations formodelling business data, there are many others.


27/51


MotivationTo clarify the systems subject matter and thereby trigger requirements thathave not yet been thought of.

Example 1The following is a model of the systems business subject matter using theUnified Modelling Language (UML) class model notation.

Dist r ict

Forecast

Road Road Sect ion

Sensor

Failed Sensor

Temperat ure Reading

Depot

Truck

1

1

1

1

1

S

Example 2The following is a model of the business data using Peter ChensEntity/ Relationship modelling notation.


28/51


Road Road Sect ion

Sensor Truck

Temperat ure

Reading

Dist rict

Forecast

Failed Sensor

Depot

Inst allat ion

Composing

Maint enance

Management

Measurement

Locat ion

Predict ion

Sch edul ing

S

N

1

1 N

N

N 1

N

N N

N

N

1

1

N

N

Fit CriterionYou can use any type of data or object model to capture thi s knowledge. Theissue is to capture the meaning of the business subject matter and theconnections between the individual parts and that you are consistent withinyour project. If you have an established company standard notation, then usethat as it will help you to reuse knowledge between projects.To support your data model you would also define:

Name of business object/ enti ty (use naming convention from 5)Statement of the purpose of the class/ entityDescription of relationships between classes/ entitiesAttributes of the object/ entity (use conventions from 5)

ConsiderationsAre there any data/object models for similar/ overlapping systems that mightbe a useful starting point? Is there a domain model for the subject matter

dealt with by this system?


29/51


11110000 LLLLooooooookkkk aaaannnndddd FFFFeeeeeeeellll RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11110000aaaa.... TTTThhhheeee iiiinnnntttteeeerrrrffffaaaacccceeeeContent

A description of the spir it of the interface. This can be in the form of textdescriptions or preliminary sketches of a possible interface.

The intention of thi s section is to state requirements relating to the interface.Your client may have given you particular demands such as style, colours tobe used, degree of interaction and so on. This section captures therequirements for the interface rather than the design for the interface.

MotivationTo capture the expectations, the constraints and the clients demands for theinterface before designing it.

ExamplesThe product shall have the same layout as the district maps that theengineering department uses now.The product shall use the company colours.The product shall be colourful and attractive to a teenage audience.The product shall appear authoritative.

ConsiderationsInterface design may overlap the requirements gathering process. Thisparticularly true if you are using prototyping as part of your requirementsprocess. As prototypes develop it is important to capture the requirementsthat relate to the look and feel. In other words, be sure that you understandyour clients intentions for the products look and feel. Record these asrequirements instead of merely having a prototype to which the client hasnodded his approval.

11110000bbbb.... TTTThhhheeee ssssttttyyyylllleeee ooooffff tttthhhheeee pppprrrroooodddduuuuccccttttContent

A description of salient features of the product that are related to the way apotential customer will see the product. For example, if your client wants the

product to appeal to the business executive, then a look and feel requirementis that the product has a conservative and professional appearance. Similarlyif the product is for sale to children, then the look and feel requirement isthat it be colourful and look like its intended for children.The requirements that you record here will guide the designers to produce aproduct as envisioned by your client.


30/51


MotivationGiven the state of todays market and peoples expectations, we cannotafford to build products that have an inadequate appearance. Once thefunctional requirements are satisfied, it is often the appearance of productsthat determines whether they are successful or not. Your task in thi s sectionis to determine precisely how the product shall appear to its intendedconsumer.

ConsiderationsThe look and feel requirements specify the your clients vision of theproducts appearance. The requirements may at first seem to be rather vague conservative and professional appearance but these will be quantifiedby their fit criterion. The fit criterion in this case give you the opportunity toextract from your client precisely what is meant, and gives the designerprecise instructions on what he is to accomplish.

11111111 UUUUssssaaaabbbbiiiilllliiiittttyyyy RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss11111111aaaa.... EEEEaaaasssseeee ooooffff uuuusssseeee....

ContentThis section describes your clients aspirations for how easy it will be for theintended users of the product to operate it. The products usability is derivedfrom the abilities of the expected users of the product and the complexity ofits functionality.

MotivationTo guide the products designers into building a product that will meet theexpectations of it s eventual users.

ExamplesThe product shall be easy for 11 year-old children to use.The product shall help the user to avoid making mistakes.The product shall make the users want to use it.The product shall be used by people with no training, and possibly nounderstanding of English.

Fit CriterionThese examples may seem simplistic, but they do express the intention of theclient. To completely specify what is meant by the requirement i t isnecessary to add a measurement of acceptance. We call this a fit criterion.The fit criterion for the above examples would be:


31/51


[An agreed percentage, say 90%] of a test panel of 11 year olds shall be ableto successfully complete [list of tasks] within [ specified time]One months use of the product shall result in a total error rate of less than[an agreed percentage, say 2%]An anonymous survey shall show that [an agreed percentage, say 75%] of theusers are regularly using the product after [ an agreed time] familiarizationperiod.

ConsiderationsRefer back to Section 3, the Users of the System, to ensure that you haveconsidered the usability requirements from the perspective of all thedifferent types of users.It may be necessary to have special consulting sessions with your users andyour client to determine whether there are any special usabili tyconsiderations that must be built into the product.You could also consider consulting a usability laboratory that has experiencewith testing the usability of products that have constraints (sections 1-7 ofthis template) similar to yours.

11111111bbbb.... EEEEaaaasssseeee ooooffff lllleeeeaaaarrrrnnnniiiinnnngggg....Content

A statement of how easy it should be to learn to use the product. This willrange from zero time for products intended for placement in the publicdomain (for example a parking meter) to a considerable time for complex,highly technical products. (We know of one product where it was necessaryfor graduate engineers to spend 18 months in training before being qualified

to use the product.)Motivation

To quantify the amount of time that your client feels is allowable before auser can successfully use the product. This requirement will guide designersin how users will learn the product. For example, the designers may buildelaborate interactive help facilities into the product, or the product may bepackaged with a tutorial. Alternatively the product may have to beconstructed so that all of its functionality is apparent upon first encounteringit.

ExamplesThe product shall be easy for an engineer to learn.A clerk shall be able to be productive within a short time.The product shall be able to be used by members of the public who willreceive no training before using it. They may have seen the advertisingcampaign.


32/51


The product shall be used by engineers who will attend 5 weeks of trainingbefore using the product.

Fit CriterionFit criterion for the above example requirements are:An engineer shall produce a [specified result] within [specified time] ofbeginning to use the product, without needing to use the manual.After receiving [number of hours] training a clerk shall be able to produce[quantity of specified outputs] per [ unit of time].[Agreed percentage] of a test panel shall successfully complete [specifiedtask] within [specified time limit].The engineers shall achieve [agreed percentage] pass rate from the finalexamination of the training.

ConsiderationsRefer back to Section 3, the Users of the System, to ensure that you haveconsidered the ease of learning requirements from the perspective of all the

different types of users.

11112222 PPPPeeeerrrrffffoooorrrrmmmmaaaannnncccceeee RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11112222aaaa.... SSSSppppeeeeeeeedddd rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

Specifies the amount of t ime available to complete specified tasks. These

often refer to response times. They can also refer to the products ability tofit into the intended environment.Motivation

Some products, usually real-time products, must be able to perform some oftheir functionali ty within a given time slot. Failure to do so may meancatastrophic failure (for example a ground-sensing radar in an airplane failsto detect an upcoming mountain) or the product will not cope with therequired volume of use (an automated ticket selling machine).

Examples

Any interface between a user and the automated system shall have amaximum response time of 2 secondsThe response shall be fast enough to avoid interrupting the users flow ofthoughtThe product shall poll the sensor every 10 seconds


33/51


The product shall download the new status parameters within 5 minutes ofa change

Fit CriterionUnit of measurementRequired range of values

Considerations

There is a wide variation in the importance of different types of speedrequirements. If you are working on a missile guidance system then speed isextremely important. On the other hand, an inventory control report that isrun once every 6 months has very little need for split second speed.Customise this section of the template to give examples of the speedrequirements that are important within your environment.

11112222bbbb.... SSSSaaaaffffeeeettttyyyy ccccrrrriiiittttiiiiccccaaaallll rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

Quantification of perceived risk of possible damage to people, property andenvironment.Motivation

To understand and highlight the potential damage that could occur whenusing the product within the expected operational environment.

ExamplesThe product shall not emit noxious gases that damage peoples health.The heat exchanger shall be shielded from human contact.

Fit CriterionDescription of the perceived riskFactors that could cause the damageUnit for measuring the factors that could cause the damageThe product shall be certi fied to comply with the Health Departmentsstandard E110-98. This is to be certified by quali fied testing engineers.No member of a test panel of [specified size] shall be able to touch the heatexchanger. The heat exchanger must also comply with safety standard

[specify which one].Considerations

The sample requirements given above apply to some, but not all, products. Itis not possible to give examples of every variation of safety criticalrequirement. To make the template work in your environment, you shouldcustomize it by adding examples that are specific to your products.


34/51


If you are building safety critical systems then the relevant safety criticalstandards are already well specified. You will likely have safety experts onyour staff. These safety experts are the best source of the relevant safetycritical requirements for your type of product. The safety experts will almostcertainly have copious information that you can use.Consult your legal department. They will be aware of the kinds of lawsuitsthat have resulted from product safety failure. This is probably the beststarting place for generating relevant safety requirements.

11112222cccc.... PPPPrrrreeeecccciiiissssiiiioooonnnn rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

Quantification of the desired accuracy of the results produced by theproduct.

MotivationTo set the client and user expectations for the precision of the product.

ExamplesAll monetary amounts shall be accurate to 2 decimal places.Accuracy of road temperature readings shall be within + or - 2 degreescentigrade.

Fit CriterionUnit of measure plus degree of precision

ConsiderationsIf you have done any detailed work on definitions, then some precisionrequirements might be adequately defined by definitions in section 5.

11112222dddd.... RRRReeeelllliiiiaaaabbbbiiiilllliiiittttyyyy aaaannnndddd AAAAvvvvaaaaiiiillllaaaabbbbiiiilllliiiittttyyyy rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

This section quantifies the necessary reliability of the product. This is usuallyexpressed as the allowable time between failures, or the total allowablefailure rate.It also quanti fies the expected availabil ity of the product.

Motivation

It is critical for some products not to fail too often. This section allows you toexplore the possibility of failure and to specify realistic levels of service. Italso gives you the opportunity to set client and user expectations about theamount of time that the product will be available for use.

ExamplesThe product shall be available for use 24 hours per day, 365 days per year.


35/51


The product shall be available for use between the hours of 8:00am and5:30pm.The escalator shall run from 6am until the last flight arrives at 10pm.The product shall achieve 99% up time.

Fit CriterionTime period/ s of expected up-time

ConsiderationsConsider carefully whether the real requirement for your product is that it isavailable for use, or that it does not fail at any time.Consider also the cost of reliabili ty and availability, and whether it is justifiedfor your product.

11112222eeee.... CCCCaaaappppaaaacccciiiittttyyyy rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

This section specifies the volumes that the product must be able to deal withand the numbers of data stored by the product.

MotivationTo ensure that the product is capable of processing the expected volumes.

ExamplesThe product shall cater for 300 simultaneous users within the period from9:00am to 11:am. Maximum loading at other periods will be 150.During a launch period the product shall cater for up to 20 people to be inthe inner chamber.

Fit CriterionIn this case, the requirement description is quantified, and thus can betested.

11113333 OOOOppppeeeerrrraaaattttiiiioooonnnnaaaallll RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11113333aaaa.... EEEExxxxppppeeeecccctttteeeedddd pppphhhhyyyyssssiiiiccccaaaallll eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnnttttContent

This section specifies the physical environment in which the product willoperate.


36/51


MotivationTo highlight conditions that might need special requirements, preparations ortraining. These requirements ensure that the product is fit to be used in i tsintended environment.

ExamplesThe product shall be used by a worker, standing up, outside in cold, rainyconditions.The product shall be used in noisy conditions with a lot of dust.The product shall be able to fit in a pocket or purse.The product shall be usable in dim light.

ConsiderationsThe work environment Is the product to operate in some unusualenvironment? Does this lead to special requirements? Also see section 11 -Usability.

11113333bbbb.... EEEExxxxppppeeeecccctttteeeedddd tttteeeecccchhhhnnnnoooollllooooggggiiiiccccaaaallll eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnnttttContent

Specification of the hardware and other devices that make up the operatingenvironment for the new system.

MotivationTo identify all the components of the new system so that the acquisition,installation and testing can be effectively managed.

Considerations

Describe the hardware and other devices that make up the operatingenvironment for the new system. This may not be known at the time of therequirements process, as these devices may be decided at design time.It may be that the operating environment is complex, and becomes a subjectof requirements study i tself.Special considerations should also be given if the product is to be embeddedin a device.If the expected operating environment is the same or similar to the currentone, then this might be adequately covered in section 6d - ImplementationEnvironment of the Current System.

11113333cccc.... PPPPaaaarrrrttttnnnneeeerrrr aaaapppppppplllliiiiccccaaaattttiiiioooonnnnssssContent

Description of other applications that the product must interface with.


37/51


MotivationRequirements for interfacing to other applications often remain undiscoveredunti l implementation t ime. Avoid a high degree of rework by discoveringthese requirements early.

ExamplesWe must be able to interface with any html browser.The new version of the spreadsheet must be able to access data from theprevious 2 versionsOur product must interface with the applications that run on the remoteweather stations

Fit CriterionFor each inter-application interface specify:- The data content- The physical material content

- The medium that carries the interface- The frequency- The volume

11114444 MMMMaaaaiiiinnnnttttaaaaiiiinnnnaaaabbbbiiiilllliiiittttyyyy aaaannnndddd PPPPoooorrrrttttaaaabbbbiiiilllliiiittttyyyy RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11114444aaaa.... HHHHoooowwww eeeeaaaassssyyyy mmmmuuuusssstttt iiiitttt bbbbeeee ttttoooo mmmmaaaaiiiinnnnttttaaaaiiiinnnn tttthhhhiiiissss pppprrrroooodddduuuucccctttt????

ContentA quantification of the time necessary to make specified changes to theproduct.

MotivationTo make everyone aware of the maintenance needs of the product.

ExamplesNew MIS reports must be available within one working week of the date therequirements are agreed

A new weather station must be able to be added to the system overnightConsiderations

There may be special requirements for maintainability, such as this productmust be able to be maintained by its end-users, or developers who are notthe original developers. This has an effect on the way that the product is


38/51


developed, and there may be additional requirements for documentation ortraining.

11114444bbbb.... AAAArrrreeee tttthhhheeeerrrreeee ssssppppeeeecccciiiiaaaallll ccccoooonnnnddddiiiittttiiiioooonnnnssss tttthhhhaaaatttt aaaappppppppllllyyyy ttttoooo tttthhhheeee mmmmaaaaiiiinnnntttteeeennnnaaaannnncccceeee ooooffff tttthhhhiiiissss pppprrrroooodddduuuucccctttt????Content

Specification of the intended release cycle for the product and the form thatthe release will take.

MotivationTo make everyone aware of how often it is intended to produce new releasesof the product.

ExamplesThe maintenance releases will be offered to end-users once a year. Every registered user will have access to our help site via the Internet.

Fit CriterionDescription of type of maintenance + Amount of effort budgeted

ConsiderationsDo you have any existing contractual commitments or maintenanceagreements that might be affected by the new system?

11114444cccc.... PPPPoooorrrrttttaaaabbbbiiiilllliiiittttyyyy rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

Description of other platforms or environments to which the product must beported.

MotivationTo quantify client and user expectations about the platforms on which theproduct will be able to run.

ExamplesThe product is expected to run under Windows 95 and UnixThe product might eventually be sold to the Japanese marketThe product is designed to run in offices, but we intend to have a versionwhich will run in restaurant kitchens

Fit CriterionSpecification of system software on which the product must operate.Specification of future environments in which the product is expected tooperate.Time allowed to make the transit ion.


39/51


ConsiderationsAsk questions from your marketing department to discover unstatedassumptions that have been made about the portability of the product.

11115555 SSSSeeeeccccuuuurrrriiiittttyyyy RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11115555aaaa.... IIIIssss tttthhhheeee ssssyyyysssstttteeeemmmm ccccoooonnnnffffiiiiddddeeeennnnttttiiiiaaaallll????Content

Specification of who has authorized access to the system, and under whatcircumstances that access is granted.

MotivationTo understand the expectations for confidentiality aspects of the system.

Examples

Only direct managers can see the personnel records of their staff.Only holders of current security clearance can enter the building.

Fit CriterionSystem function name or system data nameUser role/ s and/ or names of people who have clearance

ConsiderationsIs there any data that is sensitive to the management? Is there any data thatlow level users do not want management to have access to? Are there anyprocesses that might cause damage or might be used for personal gain? Arethere any people who should not have access to the system?Avoid solving how you will design a solution to the security requirements.For instance, dont design a password system. Your aim here is to identifywhat the securi ty requirement is. The design will come from this description.Consider asking for help. Computer security is a highly-specialised field, andone where improperly-quali fied people have no business being. If yourproduct has need of more than average security, we advise that you makeuse of a security consultant. They are not cheap, but the results of

inadequate security can be even more expensive.11115555bbbb.... FFFFiiiilllleeee iiiinnnntttteeeeggggrrrriiiittttyyyy rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

ContentSpecification of the required integrity of databases and other files.


40/51


MotivationTo understand the expectations for the integrity of the systems data.

ExamplesThe clients shall receive updated customer fi les once every 24 hours.Identical up-to-date booking information shall be available to all users of thesystem.

ConsiderationsHow will the information be used? What is the impact on the customersbusiness if the information is out of date? Will there be a ripple effect if twodifferent users have different versions of the system?

11115555cccc.... AAAAuuuuddddiiiitttt rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssssContent

Specification of the required audit checks.Motivation

To build a system that complies with the appropriate audit rules.Considerations

This section may have legal implications. You are advised to seek theapproval of your organizations auditors for what you write here.

11116666 CCCCuuuullllttttuuuurrrraaaallll aaaannnndddd PPPPoooolllliiiittttiiiiccccaaaallll RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

AAAArrrreeee tttthhhheeeerrrreeee aaaannnnyyyy ssssppppeeeecccciiiiaaaallll ffffaaaaccccttttoooorrrrssss aaaabbbboooouuuutttt tttthhhheeee pppprrrroooodddduuuucccctttt tttthhhhaaaatttt wwwwoooouuuulllldddd mmmmaaaakkkkeeee iiiitttt uuuunnnnaaaacccccccceeeeppppttttaaaabbbblllleeeeffffoooorrrr ssssoooommmmeeee ppppoooolllliiiittttiiiiccccaaaallll rrrreeeeaaaassssoooonnnn????

ContentThis section contains requirements that are specific to the sociological andpolitical factors that affect the acceptability of the product. If you aredeveloping a product for foreign markets then these requirements areparticularly relevant.

Motivation

To bring out in the open requirements that are difficult to discover becausethey are outside the cultural experience of the developers.In the case of political requirements the requirements sometimes appearirrational.


41/51


ExamplesThe product shall be able to distinguish between French, Italian and Britishroad numbering systems.The product shall keep a record of public holidays for all countries in theEuropean Union and for all states in the United States.Our company policy says that we shall buy our hardware from Unisys.The chief auditor shall veri fy all the user interfaces.

ConsiderationsQuestion whether the product is intended for a culture other than the onewith which you are familiar. Ask whether people in other countries or inother types of organizations will use the product. Do these people havedifferent habits, holidays, supersti tions, cultural norms that do not apply toyour own culture?Did you intend to develop the product on a Macintosh, when the officemanager has laid down a edict that only Windows machines are permitted?

Is a director also on the board of a company that manufactures productssimilar to the one that you intend to build?Whether you agree with these political requirements has little bearing on theoutcome. The reality is that the system has to comply with politicalrequirements even if you can find a better/ more efficient/ more economicalsolution. A few probing questions here may save some heartache later.

11117777 LLLLeeeeggggaaaallll RRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss

11117777aaaa.... DDDDooooeeeessss tttthhhheeee ssssyyyysssstttteeeemmmm ffffaaaallllllll uuuunnnnddddeeeerrrr tttthhhheeee jj j juuuurrrriiiissssddddiiiiccccttttiiiioooonnnn ooooffff aaaannnnyyyy llllaaaawwww ????Content

A statement specifying the legal requirements for this system..Motivation

To comply with the law so as to avoid later delays, law suits and legal fees.Examples

Personal information shall be implemented so as to comply with the dataprotection act.Fit Criterion

Lawyers opinion that the product does not break any laws.Considerations

Consider consulting lawyers to help identify the legal requirements?


42/51


Are there any copyrights that must be protected? Alternatively, do anycompetitors have copyrights that you might be in danger of infringing?Is it a requirement that developers have not seen competitors code or evenhave worked for competitors?Is there any pending legislation that might affect the development of thissystem?

11117777bbbb.... AAAArrrreeee tttthhhheeeerrrreeee aaaannnnyyyy ssssttttaaaannnnddddaaaarrrrddddssss wwwwiiiitttthhhh wwwwhhhhiiiicccchhhh wwwweeee mmmmuuuusssstttt ccccoooommmmppppllllyyyy ????Content

A statement specifying applicable standards and referencing detailedstandards descriptions.

MotivationTo comply with standards so as to avoid later delays.

ExampleThe product shall comply with MilSpec standards.

The product shall comply with insurance industry standards.The product shall be developed according to SSADM standard developmentsteps.

Fit CriterionThe appropriate standard-keeper that the standard has been adhered to.

ConsiderationsIt is not always apparent that there are applicable standards because theirexistence is often taken for granted. Consider the following:Are there any industry bodies that have applicable standards?Has the industry a code of practice, watchdog or ombudsman?Are there any special development steps for this type of product?

11118888 OOOOppppeeeennnn IIIIssssssssuuuueeeessss

IIIIssssssssuuuueeeessss tttthhhhaaaatttt hhhhaaaavvvveeee bbbbeeeeeeeennnn rrrraaaaiiiisssseeeedddd aaaannnndddd ddddoooo nnnnooootttt yyyyeeeetttt hhhhaaaavvvveeee aaaa ccccoooonnnncccclllluuuussssiiiioooonnnn....ContentA statement of factors that are uncertain and might make significantdifference to the product.


43/51


MotivationTo bring uncertainty out in the open and provide objective input to riskanalysis.

ExamplesOur investigation into whether or not the new version of the processor wi llbe suitable for our application is not yet complete.The government are planning to change the rules about who is responsiblefor gritting the motor ways, but we do not know what the changes might be.

ConsiderationsAre there any issues that have come up from the requirements gathering thathave not yet been resolved? Have you heard of any changes that might occurin the other organisations/ systems on your context diagram? Are there anylegislative changes that might affect your system? Any rumours about yourhardware/ software suppliers that might have an impact?

11119999 OOOOffffffff----tttthhhheeee----SSSShhhheeeellllffff SSSSoooolllluuuuttttiiiioooonnnnssss

11119999aaaa.... IIIIssss tttthhhheeeerrrreeee aaaa rrrreeeeaaaaddddyyyy----mmmmaaaaddddeeee ssssyyyysssstttteeeemmmm tttthhhhaaaatttt ccccoooouuuulllldddd bbbbeeee bbbboooouuuugggghhhhtttt????Content

List of existing products that should be investigated as potential solutions.Reference any surveys that have been done on these products.

Motivation

To give consideration to whether or not a solution can be bought.Considerations

Is it possible to buy something that already exists or is about to becomeavailable? It may not be possible at this stage to say with a lot of confidence,but any likely products should be listed here.Also consider whether there are products that must not be used.

11119999bbbb.... CCCCaaaannnn rrrreeeeaaaaddddyyyy----mmmmaaaaddddeeee ccccoooommmmppppoooonnnneeeennnnttttssss bbbbeeee uuuusssseeeedddd ffffoooorrrr tttthhhhiiiissss pppprrrroooodddduuuucccctttt????Content

Description of the candidate components, either bought-in or built by yourcompany, that could be used by this project. List libraries that could be asource of components.

MotivationReuse rather than reinvention.


44/51


11119999....3333 IIIIssss tttthhhheeeerrrreeee ssssoooommmmeeeetttthhhhiiiinnnngggg tttthhhhaaaatttt wwwweeee ccccoooouuuulllldddd ccccooooppppyyyy????Content

List of other similar systems.Motivation

Reuse rather than reinvention.Examples

Another electricity company has built a customer service system. Theirhardware is different from ours but we could buy their specification and cutour analysis effort by approximately 60%.

ConsiderationsWhile a ready-made solution may not exist, there may well be somethingthat, in it s essence, is similar enough that you could copy, and possiblymodify, to better effect that starting from scratch. This is dangerous becauseit relies on the base system being of good quality.This question should always be answered. The act of answering will force youto look at other existing solutions to similar problems.

22220000 NNNNeeeewwww PPPPrrrroooobbbblllleeeemmmmssss

22220000aaaa.... WWWWhhhhaaaatttt pppprrrroooobbbblllleeeemmmmssss ccccoooouuuulllldddd tttthhhheeee nnnneeeewwww ssssyyyysssstttteeeemmmm ccccaaaauuuusssseeee iiiinnnn tttthhhheeee ccccuuuurrrrrrrreeeennnntttt eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnntttt????Content

A description of how the new system will affect the current implementationenvironment. This section should also cover things that the new productshouldnot do.

MotivationThe intention is to discover early any potential conflicts that might otherwisenot be realised until implementation time.

ExamplesAny change to the scheduling system will affect the work of the engineers inthe divisions and the gritter truck drivers.

ConsiderationsIs it possible that the new system will damage some already existing system?Can people be displaced, or affected by the new system?This requires a study of the current environment. A model highlighting theeffects of the change is a good way to make this information widelyunderstandable.


45/51


22220000bbbb.... WWWWiiiillllllll tttthhhheeee nnnneeeewwww ddddeeeevvvveeeellllooooppppmmmmeeeennnntttt aaaaffffffffeeeecccctttt aaaannnnyyyy ooooffff tttthhhheeee iiiinnnnssssttttaaaalllllllleeeedddd ssssyyyysssstttteeeemmmm????Content

Specification of the interfaces between new and existing systems.Motivation

Very rarely is a new development intended to stand completely alone.Usually there is some existing system that the new one must coexist with.This question forces you to look carefully at the existing system and examineit for potential conflicts with the new development.

22220000cccc.... WWWWiiiillllllll aaaannnnyyyy ooooffff oooouuuurrrr eeeexxxxiiiissssttttiiiinnnngggg uuuusssseeeerrrrssss bbbbeeee aaaaddddvvvveeeerrrrsssseeeellllyyyy aaaaffffffffeeeecccctttteeeedddd bbbbyyyy tttthhhheeee nnnneeeewwwwddddeeeevvvveeeellllooooppppmmmmeeeennnntttt????

ContentDetails of any adverse reaction that might be suffered by existing users

MotivationSometimes existing users are using a product in such a way that they will

suffer il l effects from the new system/ feature. Identi fy any likely adverseuser reaction, determine whether we care and what precautions we will take.

22220000dddd.... WWWWhhhhaaaatttt lllliiiimmmmiiiittttaaaattttiiiioooonnnnssss eeeexxxxiiiisssstttt iiiinnnn tttthhhheeee aaaannnnttttiiiicccciiiippppaaaatttteeeedddd iiiimmmmpppplllleeeemmmmeeeennnnttttaaaattttiiiioooonnnn eeeennnnvvvviiiirrrroooonnnnmmmmeeeennnntttt tttthhhhaaaattttmmmmaaaayyyy iiiinnnnhhhhiiiibbbbiiiitttt tttthhhheeee nnnneeeewwww ssssyyyysssstttteeeemmmm????

ContentStatement of any potential problems with the new automated technology ornew ways of structuring the organisation.

Motivation

The intention is to make early discovery of any potential conflicts that mightotherwise not be realised until implementation time.

ExamplesThe planned new server is not powerful enough to cope with our projectedgrowth pattern.

ConsiderationsThis requires a study of the intended implementation environment.

22220000eeee.... WWWWiiiillllllll tttthhhheeee nnnneeeewwww ssssyyyysssstttteeeemmmm ccccrrrreeeeaaaatttteeee ooootttthhhheeeerrrr pppprrrroooobbbblllleeeemmmmssss????Content

Identification of situations that we might not be able to cope with.Motivation

To guard against situations where the product might fail.


46/51


ConsiderationsWill we create a demand for our product that we are not able to service? Willthe new system cause us to fall foul of laws that do not currently apply? Willthe existing hardware cope?There are potentially hundreds of unwanted effects. It pays to answer thisquestion very carefully.

22221111 TTTTaaaasssskkkkssss

22221111aaaa.... WWWWhhhhaaaatttt sssstttteeeeppppssss hhhhaaaavvvveeee ttttoooo bbbbeeee ttttaaaakkkkeeeennnn ttttoooo ddddeeeelllliiiivvvveeeerrrr tttthhhheeee ssssyyyysssstttteeeemmmm????Content

Details of the life cycle and approach that will be used to deliver the product.A high level process diagram showing the tasks and interfaces between themis a good way to communicate this information.

MotivationTo specify the approach that will be taken to deliver the product so thateveryone has the same expectations.

ConsiderationsDepending on the level of maturity of your process, the new product will bedeveloped using your standard approach. However, there are somecircumstances that are special to a particular product and will necessitatechanges to your lifecycle. While these are not a product requirement, theyare needed if the product is to be successfully developed.If possible, attach an estimate of the time and resources need for each taskbased on the requirements that you have specified. Tag your estimates to theevents/ use cases/ functions that you specified in sections 8 and 9.Do not forget data conversion, user training and cutover. We have listedthese because they are usually ignored when projects set implementationdates.

22221111bbbb.... DDDDeeeevvvveeeellllooooppppmmmmeeeennnntttt pppphhhhaaaasssseeeessssContent

Specification of each phase of development and the components in theoperating environment.

MotivationTo identify the phases necessary to implement the operating environment forthe new system so that the implementation can be managed.


47/51


Fit CriterionName of the phaseRequired operational dateOperating environment components includedFunctional requirements includedNon-functional requirements included

ConsiderationsIdentify which hardware and other devices are necessary for each phase ofthe new system. This may not be known at the time of the requirementsprocess, as these devices may be decided at design time.

22222222 CCCCuuuuttttoooovvvveeeerrrr

22222222aaaa.... WWWWhhhhaaaatttt ssssppppeeeecccciiiiaaaallll rrrreeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttssss ddddoooo wwwweeee hhhhaaaavvvveeee ttttoooo ggggeeeetttt tttthhhheeee eeeexxxxiiiissssttttiiiinnnngggg ddddaaaattttaaaa,,,, aaaannnnddddpppprrrroooocccceeeedddduuuurrrreeeessss ttttoooo wwwwoooorrrrkkkk ffffoooorrrr tttthhhheeee nnnneeeewwww ssssyyyysssstttteeeemmmm????Content

A list of the Cutover activities. Timetable for implementation.Motivation

To identify cutover tasks as input to the project planning process.Considerations

Will you be using phased implementation to install the new system? If so,describe the requirements that will be implemented by each of the majorphases.What data conversion has to be done? Are there special programs to bewritten to transport data from an existing system to the new one? If so, therequirements for this program(s) are to be described here.What manual backup is needed while the new system is installed?When are each of the major components to be put in place, when are phasesof the implementation to be released?This section is the timetable for implementation of the new system.

22222222bbbb.... WWWWhhhhaaaatttt ddddaaaattttaaaa hhhhaaaassss ttttoooo bbbbeeee mmmmooooddddiiiiffffiiiieeeedddd // / / ttttrrrraaaannnnssssllllaaaatttteeeedddd ffffoooorrrr tttthhhheeee nnnneeeewwww ssssyyyysssstttteeeemmmm????Content

List of data translation tasks.


48/51


MotivationTo discover missing tasks that will affect the size and boundaries of theproject.

Fit CriterionDescription of the current technology that holds the dataDescription of the new technology that wi ll hold the data

Description of the data translation task/ sForeseeable problems

ConsiderationsEvery time you make an addition to your dictionary (see section 4) ask thequestion What are all the places that this data is currently held and will thenew system affect that implementation?.

22223333 RRRRiiiisssskkkkssssAll projects involve risk. By this we mean the risk that something will gowrong. Risk is not necessarily a bad thing, as no progress is made withouttaking some risk. However, there is a difference between unmanaged risk say shooting dice at a craps table and managed risk where the probabilitiesare well understood, and contingencies made. Risk is only a bad thing if therisks are ignored and they become problems. Risk management is assessingwhich risks are most likely to apply to the project, deciding a course of action if they become problems, and monitoring projects to give earlywarnings of risks becoming problems.

This section of your specification should contain a list of the mostlikely and the most serious risks for your project. Against each risk includethe probability of that risk becoming a problem. Capers Jones book

Assessment and Control of Software Risks . Prentice-Hall, Englewood Cliffs,NJ. 1994 gives comprehensive lists of risks and their probabilities, you canuse these as a starting point. For example, Jones cites the following risks asbeing the most serious:

Inaccurate metrics Inadequate measurement Excessive schedule pressure

Management malpractice Inaccurate cost estimating Silver bullet syndrome Creeping user requirements Low quality Low productivity Cancelled projects


49/51


It is also useful input to project management if you include the impacton the schedule, or the cost, if the risk does become a problem.

22224444 CCCCoooossssttttssssThe other cost of requirements is the amount of money or effort that youhave to spend building them into a product. Once the requirementsspecification is complete, you can use one of the estimating methods toassess the cost, and express this in a monetary amount or time to build.

There is no best method to use when estimating. However yourestimates should be based on some tangible, countable, artifact. If you areusing this template then, as a result of doing the work of requirementsspecification, you are producing many measurable deliverables. Forexample:

Number of input and output flows on the work contextNumber of business eventsNumber of product use casesNumber of functional requirementsNumber of non-functional requirementsNumber of requirements constraintsNumber of function points

The more detailed work you do on your requirements the more accurate willbe your deliverables. Your cost estimate is the amount of resources youestimate each type of deliverable will take to produce within yourenvironment. You can do some very early cost estimates based on the work context. At that stage, your knowledge of the work will be general and you

should reflect this by making the cost estimate a range rather than one figure.As you get more knowledge about the requirements we suggest you tryusing function point counting not because it is an inherently superiormethod - but because it is so commonly accepted. So much is known aboutit, that it is possible to make easy comparisons with other products, and otherinstallations productivity.

It is important that your client knows at this stage what the product islikely to cost. You usually express this as a total cost to complete theproduct, but you may also find it advantageous to be able to point out thecost of individual requirements.

Whatever you do, do not leave the costs in the lap of hystericaloptimism. Make sure that this section includes meaningful numbers based ontangible deliverables.


50/51


22225555 UUUUsssseeeerrrr DDDDooooccccuuuummmmeeeennnnttttaaaattttiiiioooonnnn aaaannnndddd TTTTrrrraaaaiiiinnnniiiinnnngggg

22225555aaaa.... TTTThhhheeee ppppllllaaaannnn ffffoooorrrr bbbbuuuuiiiillllddddiiiinnnngggg tttthhhheeee uuuusssseeeerrrr ddddooooccccuuuummmmeeeennnnttttaaaattttiiiioooonnnn....Content

List of the user documentation that will be supplied as part of the systemand to describe the training that will be available.

Motivatio

Documents

Volere Specification Template v6