Software Requirements Specification

Example

This is an example Software Requirements Specification (SRS), illustrating the typical structure and the use of Spexygen commands to define the traceable requirement work artifacts.

Note

Please note the generated forward-traceability and the backward-traceability links (augmented with the brief descriptions) in the "work artifacts" and "code artifacts". Also, try clicking on the provided traceability links as well as searching the UIDs in the Doxygen "search" box.

Concepts & Definitions

Description of concepts and definitions...

Requirements

Definitions of formal requirements specifications with Spexygen commands.

---

SRS_EXA_FF_00

My project shall provide a free function foo().

Description
Longer description of the requirement

Forward Traceability (truncated to 1 level(s))

• free_fun(): Free function brief description

---

SRS_EXA_Foo_00

My project shall provide a class Foo.

Description
Longer description of the requirement

Forward Traceability (truncated to 1 level(s))

• SRS_EXA_Foo_01: Class Foo shall provide a public attribute x.
• SRS_EXA_Foo_02: Class Foo shall provide a constructor.
• SRS_EXA_Foo_03: Class Foo shall provide a verify operation.
• SRS_EXA_Foo_04: Class Foo shall provide an update operation.
• SRS_EXA_Foo_05: Class Foo shall be a singleton.
• Foo: Class Foo brief description

---

SRS_EXA_Foo_01

Class Foo shall provide a public attribute x.

Description
Longer description of the requirement

Backward Traceability

• SRS_EXA_Foo_00: My project shall provide a class Foo.

Forward Traceability (truncated to 2 level(s))

• Foo::x: Attribute x of class Foo brief description
  • Foo::x_dis: Duplicate Inverse Storage for attribute Foo::x

---

SRS_EXA_Foo_02

Class Foo shall provide a constructor.

Description
Longer description of the requirement

Backward Traceability

• SRS_EXA_Foo_00: My project shall provide a class Foo.

Forward Traceability (truncated to 2 level(s))

• Foo_ctor(): Constructor of class Foo brief description
  • TUN_PRJ_Foo_ctor_01: constructor test

---

SRS_EXA_Foo_03

Class Foo shall provide a verify operation.

Description
Longer description of the requirement

Backward Traceability

• SRS_EXA_Foo_00: My project shall provide a class Foo.

Forward Traceability

• Foo_verify_(): Verify operation to check the class invariant
  • Foo::x_dis: Duplicate Inverse Storage for attribute Foo::x
  • TUN_PRJ_Foo_verify_00: verify positive test
  • TUN_PRJ_Foo_verify_01: verify negative test

---

SRS_EXA_Foo_04

Class Foo shall provide an update operation.

Description
Longer description of the requirement

Backward Traceability

• SRS_EXA_Foo_00: My project shall provide a class Foo.

Forward Traceability

• Foo_update_(): Update operation to update the class invariant

---

SRS_EXA_Foo_05

Class Foo shall be a singleton.

Description
Longer description of the requirement

Backward Traceability

• SRS_EXA_Foo_00: My project shall provide a class Foo.

Forward Traceability

• Foo_inst: Foo instance brief description (singleton)

---

Example