Getting Started#

Getting Started on Requirements
status: valid
security:
safety:
status: valid
tags: requirements_engineering

This document describes the steps which need to be done to create requirements, derive child requirements and finally to perform the formal requirement inspection.

Therefore both a Requirements Guideline and a Concept Description are available.

The subsequent steps of linking requirements to code and test cases are described in different guidelines:

Linking Requirements

  • to code: <TBD Implementation Guideline>

  • to tests: <TBD Verification Guideline>

General Workflow#

../../../_images/requirements_workflow.svg

Fig. 2 Requirements Workflow#

The details of what needs to be done in each steps are described in the Workflow for Creating a Requirement

Tooling Support#

Linking Requirements to Source Code#

For linking requirements to source code a tool is available:

<TBD link implementation guideline>

Linking Requirements to Tests#

For linking Requirements to tests metatags shall be used <TBD link Verification Guidline>

Developer Experience#

Additionally tooling is provided to assist the Contributor to define the requirements in spinx needs. The current feature set is described as IDE requirements:

No needs passed the filters

A HowTo which describes the setup of Sphinx Needs in VScode is available here: <TBD>

For all RST files also a linter is configured, it will be automatically run in the CI upon check-in. Locally it can be run via

bazel test //:format.check