CASE STUDY

.

Software Requirements Specification Draft

for

<Project>

Version 1.0 approved

Prepared by <author>

<organization>

date created>

.

Revision History

Name Date Reason for Changes Version Your name MM DD,

202x Include reason

Draft Software Requirements Specification Draft <Project> Page iii

Contents 1. Introduction ..............................................................................................................................1

1.1 Purpose ........................................................................................................................................ 1 1.2 Document Conventions ............................................................................................................... 1 1.3 Intended Audience and Reading Suggestions.............................................................................. 1 1.4 Product Scope .............................................................................................................................. 1 1.5 References ................................................................................................................................... 2

2. Overall Description ..................................................................................................................3 2.1 Product Perspective ..................................................................................................................... 3 2.2 Product Functions ........................................................................................................................ 3 2.3 User Classes and Characteristics ................................................................................................. 3 2.4 Operating Environment ............................................................................................................... 4 2.5 Design and Implementation Constraints ...................................................................................... 4 2.6 User Documentation .................................................................................................................... 4 2.7 Assumptions and Dependencies .................................................................................................. 4

3. External Interface Requirements ...........................................................................................5 3.1 User Interfaces ............................................................................................................................. 5 3.2 Hardware Interfaces ..................................................................................................................... 5 3.3 Software Interfaces ...................................................................................................................... 5 3.4 Communications Interfaces ......................................................................................................... 6

4. System Features .......................................................................................................................7 4.1 System Feature 1 ......................................................................................................................... 7 4.2 System Feature 2 ......................................................................................................................... 8 4.3 Use Cases ..................................................................................................................................... 8

5. Other Nonfunctional Requirements .....................................................................................10 5.1 Safety Requirements .................................................................................................................. 10 5.2 Security Requirements ............................................................................................................... 10 5.3 Software Quality Attributes ....................................................................................................... 11 5.4 Business Rules ........................................................................................................................... 11

6. Other Requirements ..............................................................................................................12 6.1 Performance Requirements ........................................................................................................ 12

Appendix .......................................................................................................................................13 Appendix A: Glossary..................................................................................................................13 Appendix B: Use Case Models ....................................................................................................14 Appendix C: DataFlow Diagrams ..............................................................................................17 Appendix D: Entity Relationship Diagram ...............................................................................19 Appendix E: Class Diagram ........................................................................................................20

1. Introduction <Describe the contents of this section. Remove these directions after completing the section.>

1.1 Purpose

<Identify the product whose software requirements are specified in this document, including the revision or release number. Describe the scope of the product that is covered by this SRS, particularly if this SRS describes only part of the system or a single subsystem. Remove these directions after completing the section.>

1.2 Document Conventions

<Describe any standards or typographical conventions that were followed when writing this SRS, such as fonts or highlighting that have special significance. For example, state whether priorities for higher-level requirements are assumed to be inherited by detailed requirements, or whether every requirement statement is to have its own priority. Remove these directions after completing the section.>

1.3 Intended Audience and Reading Suggestions

<Describe the different types of reader that the document is intended for, such as developers, project managers, marketing staff, users, testers, and documentation writers. Describe what the rest of this SRS contains and how it is organized. Suggest a sequence for reading the document, beginning with the overview sections, and proceeding through the sections that are most pertinent to each reader type. Remove these directions after completing the section.>

1.4 Product Scope

<Provide a short description of the software being specified and its purpose, including relevant benefits, objectives, and goals. Relate the software to

Software Requirements Specification for <Project> Page 2

corporate goals or business strategies. If a separate vision and scope document is available, refer to it rather than duplicating its contents here. Remove these directions after completing the section.>

1.5 References

<List any other documents or Web addresses to which this SRS refers. These may include user interface style guides, contracts, standards, system requirements specifications, use case documents, or a vision and scope document. Provide enough information so that the reader could access a copy of each reference, including title, author, version number, date, and source or location. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 3

2. Overall Description

<Describe the contents of this section. Remove these directions after completing the section.>

2.1 Product Perspective

<Describe the context and origin of the product being specified in this SRS. For example, state whether this product is a follow-on member of a product family, a replacement for certain existing systems, or a new, self-contained product. If the SRS defines a component of a larger system, relate the requirements of the larger system to the functionality of this software and identify interfaces between the two. A simple diagram that shows the major components of the overall system, subsystem interconnections, and external interfaces can be helpful. Remove these directions after completing the section.>

2.2 Product Functions

<Summarize the major functions the product must perform or must let the user perform. Details will be provided in Section 3, so only a high-level summary (such as a bullet list) is needed here. Organize the functions to make them understandable to any reader of the SRS. A picture of the major groups of related requirements and how they relate, such as a top-level dataflow diagram or object class diagram, is often effective. Remove these directions after completing the section.>

2.3 User Classes and Characteristics

<Identify the various user classes that you anticipate will use this product. User classes may be differentiated based on frequency of use, subset of product functions used, technical expertise, security or privilege levels, educational level, or experience. Describe the pertinent characteristics of each user class. Certain requirements may pertain only to certain user classes. Distinguish the most important user classes for this product from those who are less important to satisfy. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 4

2.4 Operating Environment

<Describe the environment in which the software will operate, including the hardware platform, operating system and versions, and any other software components or applications with which it must peacefully coexist. Remove these directions after completing the section.>

2.5 Design and Implementation Constraints

<Describe any items or issues that will limit the options available to the developers. These might include corporate or regulatory policies; hardware limitations (timing requirements, memory requirements); interfaces to other applications; specific technologies, tools, and databases to be used; parallel operations; language requirements; communications protocols; security considerations; design conventions or programming standards (for example, if the customer’s organization will be responsible for maintaining the delivered software). Remove these directions after completing the section.>

2.6 User Documentation

<List the user documentation components (such as user manuals, on-line help, and tutorials) that will be delivered along with the software. Identify any known user documentation delivery formats or standards. Remove these directions after completing the section.>

2.7 Assumptions and Dependencies

<List any assumed factors (as opposed to known facts) that could affect the requirements stated in the SRS. These could include third-party or commercial components that you plan to use, issues around the development or operating environment, or constraints. The project could be affected if these assumptions are incorrect, are not shared, or change. Also identify any dependencies the project has on external factors, such as software components that you intend to reuse from another project, unless they are already documented elsewhere (for example, in the vision and scope document or the project plan). Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 5

3. External Interface Requirements

<Describe the contents of this section. Remove these directions after completing the section.>

3.1 User Interfaces

<Describe the logical characteristics of each interface between the software product and the users. This may include sample screen images, any GUI standards or product family style guides that are to be followed, screen layout constraints, standard buttons and functions (e.g., help) that will appear on every screen, keyboard shortcuts, error message display standards, and so on. Define the software components for which a user interface is needed. Details of the user interface design should be documented in a separate user interface specification. Remove these directions after completing the section.>

3.2 Hardware Interfaces

<Describe the logical and physical characteristics of each interface between the software product and the hardware components of the system. This may include the supported device types, the nature of the data and control interactions between the software and the hardware, and communication protocols to be used. Remove these directions after completing the section.>

3.3 Software Interfaces

<Describe the connections between this product and other specific software components (name and version), including databases, operating systems, tools, libraries, and integrated commercial components. Identify the data items or messages coming into the system and going out and describe the purpose of each. Describe the services needed and the nature of communications. Refer to documents that describe detailed application programming interface protocols. Identify data that will be shared across software components. If the data sharing mechanism must be implemented in a specific way (for example, use of a global data area in a multitasking operating system), specify this as an implementation constraint. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 6

3.4 Communications Interfaces

<Describe the requirements associated with any communications functions required by this product, including e-mail, web browser, network server communications protocols, electronic forms, and so on. Define any pertinent message formatting. Identify any communication standards that will be used, such as FTP or HTTP. Specify any communication security or encryption issues, data transfer rates, and synchronization mechanisms. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 7

4. System Features

<Describe the contents of this section. This template illustrates organizing the functional requirements for the product by system features, the major services provided by the product. You may prefer to organize this section by use case, mode of operation, user class, object class, functional hierarchy, or combinations of these, whatever makes the most logical sense for your product. Remember that use cases also identify functional requirements. These features need to be uniquely identified with a numbering convention. Remove these directions after completing the section.>

4.1 System Feature 1

<Do not really use the phrase “System Feature 1.” State the feature name in just a few words.> 4.1.1 Description and Priority <Provide a short description of the feature and indicate whether it is of High, Medium, or Low priority. You could also include specific priority component ratings, such as benefit, penalty, cost, and risk (each rated on a relative scale from a low of 1 to a high of 9). Remove these directions after completing the section.> 4.1.2 Stimulus/Response Sequences

<List the sequences of user actions and system responses that stimulate the behavior defined for this feature. These will correspond to the dialog elements associated with use cases. Remove these directions after completing the section.>

4.1.3 Functional Requirements <Itemize the detailed functional requirements associated with this feature. These are the software capabilities that must be present for the user to carry out the services provided by the feature, or to execute the use case. Include how the product should respond to anticipated error conditions or invalid inputs. Requirements should be concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder to indicate when necessary information is

Software Requirements Specification for <Project> Page 8

not yet available. Each requirement must use the word “shall” in the statement like “The system shall…”>

<Each requirement should be uniquely identified with a sequence number or a meaningful tag of some kind.

REQ-1: <Name> Description: <Include the description of the requirement> Use Case Reference: <Provide the unique ID and name of the use

case that applies to this requirement. Include all applicable use cases.>

Remove these directions after completing the section.>

REQ-2: <Follow the same format as above for REQ1..

Remove these directions after completing the section.>

4.2 System Feature 2

<Add the second System Feature following System Feature 2 above and continue until all system features and their applicable use cases are identified.. Add additional features and requirements as needed. Remove these directions after completing the section.>

4.3 Use Cases

<List all use cases including their unique ID (like Use Case 1) and description like the following example: Use Case 1. <Enter the name of the use case. Names are verb plus object

like “Make appointment”.> Description: <Enter a description of the use case> Use Case 2. <Enter the name of the use case. Names are verb plus object like “Make appointment”.> Description: <Enter a description of the use case>

Software Requirements Specification for <Project> Page 9

<Add all use cases here> Note that in the appendix there are additional entries for use cases. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 10

5. Other Nonfunctional Requirements

<Describe the contents of this section. Note that for each category, the number of the requirement must be unique. For example use

• Safety 1, Safety 2, etc. • Security 1, Security 2, etc. • Quality 1, Quality 2, etc. • Business Rule 1, Business Rule 2, etc.

Include a description of the requirement. For example: Safety 1. <Name of requirement> Description: <Include a description of the requirement.> Remove these directions after completing the section.>

5.1 Safety Requirements

<Specify those requirements that are concerned with possible loss, damage, or harm that could result from the use of the product. Define any safeguards or actions that must be taken, as well as actions that must be prevented. Refer to any external policies or regulations that state safety issues that affect the product’s design or use. Define any safety certifications that must be satisfied. Remove these directions after completing the section.>

5.2 Security Requirements

<Specify any requirements regarding security or privacy issues surrounding use of the product or protection of the data used or created by the product. Define any user identity authentication requirements. Refer to any external policies or regulations containing security issues that affect the product. Define any security or privacy certifications that must be satisfied. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 11

5.3 Software Quality Attributes

<Specify any additional quality characteristics for the product that will be important to either the customers or the developers. Some to consider are adaptability, availability, correctness, flexibility, interoperability, maintainability, portability, reliability, reusability, robustness, testability, and usability. Write these to be specific, quantitative, and verifiable when possible. At the least, clarify the relative preferences for various attributes, such as ease of use over ease of learning. Remove these directions after completing the section.>

5.4 Business Rules

<List any operating principles about the product, such as which individuals or roles can perform which functions under specific circumstances. These are not functional requirements in themselves, but they may imply certain functional requirements to enforce the rules. Use the unique numbering guidelines from above. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 12

6. Other Requirements

<Describe the contents of this section. Remove these directions after completing the section.> <Define any other requirements not covered elsewhere in the SRS. This might include database requirements, internationalization requirements, legal requirements, reuse objectives for the project, and so on. Add any new sections that are pertinent to the project. Remove these directions after completing the section.>

6.1 Performance Requirements

<If there are performance requirements for the product under various circumstances, state them here and explain their rationale, to help the developers understand the intent and make suitable design choices. Specify the timing relationships for real time systems. Make such requirements as specific as possible. You may need to state performance requirements for individual functional requirements or features. Use the following formatting: Performance 1. <Name of requirement> Description: <Include a description of the requirement.> Performance 2. <Name of requirement> Description: <Include a description of the requirement.> Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 13

Appendix

<Include any additional documents in this section. Remove these directions after completing the section.

Appendix A: Glossary

<Define all the terms necessary to properly interpret the SRS, including acronyms and abbreviations. Organizations may build a separate glossary that spans multiple projects or the entire organization, and just include terms specific to a single project in each SRS. Remove these directions after completing the section. Terms should be in alphabetical order> Remove these directions after completing the section.

Software Requirements Specification for <Project> Page 14

Appendix B: Use Case Models

<Include Use Case Diagrams, use case table with name and description in alphabetical order, Actor table with name and definition in alphabetical order, and Detailed Use Case Models in alphabetical order for the Case Study. For the Detailed Use Cases, complete the Detailed Use Case Template and post in this section. Note that the list of use cases and their description Remove these directions after completing the section.> B1. FCS Use Case Diagram <Insert UML Use Case Diagram here. Remove these directions after completing the section.> B2. Use Case and Actor Descriptions <Complete the following tables for the Use Case Diagram. Remove these directions after completing the section. For the actor definition use the definition statement from your assignment. Remove these directions after completing the section.> Actor Table

Use Case Table Use Case Name Use Case Description … … … …

Actor Name Actor Definition … … … …

Software Requirements Specification for <Project> Page 15

B3. Detailed Use Cases <Use the following template for detailed use cases. There will be only one detailed use case for this section. There could be literally hundreds of use cases depending on the size of the application. We are using just on as an example. Your assignment will identify the detailed use case. This is just a Word table that you can extend, as necessary. Remove these directions after completing the section.> Detailed Use Case Template Based on Figure 4-1 (p 151) and Figure 4-3 on p (155) in your textbook. Use Case Name:

ID: Priority:

Actors: Description: Trigger: Preconditions: Normal Course: (Alternate Actor Response with System Response) 1. This use case begins when…. 2. 3. Alternative Course: (Alternate Actor Response with System Response 1. 2.

Software Requirements Specification for <Project> Page 16

3. Postconditions: Exceptions:

Software Requirements Specification for <Project> Page 17

Appendix C: DataFlow Diagrams

<Include Context DFD and Level 0 DFD for the Case Study. Include a description of each diagram. For the Level 0 diagram provide a description of each process, external entity, dataflow, and datastore. Remove these directions after completing the section.> C.1. Context DFD Context DFD for Case Study <Insert Context DFD Diagram here. Remember that a Context DFD shows only one process: FCS Appointment and Scheduling System. There will be External Entities (at least one for each User or external system). Dataflows from each External Entity into the System and from the System to External Entities. See the example Tune Context Diagram in Figure 5.15, p. 211 in your textbook. Remove these directions after completing the section.> Discussion of Context DFE for FCS Case Study <Insert a description of your Context Diagram here. Remove these directions after completing the section.> C2. Level 0 DFD C2.1 Level 0 DFD for the Case Study <Insert Level 0 Context Diagram here. Remember that for a Level 0 we break the System into sub-processes and each process becomes a process at Level 0. Then we add the dataflows from the context Diagram and break them up, as necessary. The dataflows and their composition must balance from level-to- level DFD. See the example Tune Source Level 0 DFD Diagram in Figure 5.17, p. 213 in your textbook. Notice that the processes and datastores are numbered. Remove these directions after completing the section.> C2.2 Discussion of Level 0 DFD for FCS Case Study <Insert a description of your Level 0 Diagram here. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 18

C.3. Data Dictionary for DFDs. <Complete the following Data Dictionary Tables for DFDs. You can add additional entries to the tables as needed. Use alphabetical order for all tables except the Process and DataStore tables which should be ordered by process /DataStore number. Remove these directions after completing the section.> C.3.1 Process Table Process Number Name

Process Description

Input DataFlows and Source

Output DataFlows and Destination

DataFlows DataFlow Source

DataFlows DataFlow Destination

C.3.2 External Entity Table External Entity Name External Entity Description

C.3.3 DataStore Table DataStore Number and Name

DataStore Description List of Elements in the DataStore

C.3.4 DataFlow Table DataFlow Name

DataFlow Description List of Elements in the DataFlow

Software Requirements Specification for <Project> Page 19

Appendix D: Entity Relationship Diagram

<Include an Entity Relationship Diagram for the Case Study. Remove these directions after completing the section.> D.1 Case Study ERD <Insert your ERD for the Case Study. See the example Tune DFD in Figure 6- 14, p. 239 in your textbook. Remove these directions after completing the section.> D.2 Case Study Entity Definitions <Insert your ERD Entity Definitions in alphabetical order for the Case Study. See the example Tune DFD in Figure 6-14, p. 239 in your textbook. Remove these directions after completing the section. Remember that definitions use the template “A (name of entity) is a…and complete the sentence. Remove these directions after completing the section.> Entity Definitions Entity Name Definition

Doctor A Doctor is a person who provides services to Patients of FCS.

D.3 Discussion of the ERD for the Case Study <Insert a description of your ERD here. Remove these directions after completing the section.> D.4 Corrections for previous SRS. < List any corrections made for previous SRS. Remove these directions after completing the section.>

Software Requirements Specification for <Project> Page 20

Appendix E: Class Diagram

<Include a UML compliant Class Diagram for the Case Study. This is similar to the ERD except for this version of the class diagram you need to include the operations/methods. Normally in OOAD we start with use cases and then construct a class diagram. The class diagram can be used for different purposes throughout the development process. It may be a controller to be used to control a use case. It may also be a form, dialog box, or other object in the design. The class diagram is very versatile. Remove these directions after completing the section.> E.1 FCS Class Diagram <Insert your UML domain class diagram here. Remove these directions after completing the section.> E.2 Class Definitions <Complete the definition for each class in the table below. Remove these directions after completing the section.> Class Definitions Class Name Definition

Patient A Patient is a person who is registered with FCS and receives services.

E.3 FCS Class Diagram Discussion <Include a discussion of your Class Diagram for the Case Study. Remove these directions after completing the section.> Add additional sections as needed.