REL - Requirements Engineering Language

The REL framework includes a domain specific language to handle requirements in large software projects. It is used to create a requirements model, which consists of the specification and the actual requirements data.

The Requirements Specification (file extension rs) contains definitions of types and enumerations, which structure the requirements. For every project, it is necessary to define the requirements specification and adapt it to the project's needs.

The Requirements Data (file extension rd) contains the actual data. It consists of instances of the types defined in the specification, which carry the corresponding data.

Example

Requirements Specification spec.rs:

type Requirement
{
    Unique_Id : id,
    Text : string,
    /* Defines the state of the requirement,
       whether it is already accepted by
       the product owner. */
    State : RequirementState,
}

type Information
{
    Unique_Id : id,
    Text : string,
}

enum RequirementState 
{
    Draft,
    In_Discussion,
    Accepted,
    Rejected,
}

Typically in the specification, a type Requirement is defined, which has a set of attributes, like the requirement text and a unique identifier. Additionally, enumerations can be used for further attributes and their discrete values.

Requirements Data req_data.rd:

Requirement
{
    Unique_Id : dsl1,
    Text : "The REL language shall support comments in both
    specification and data files.",
    State : Accepted,
}

Within the data part, the type Requirement is instantiated multiple times, each instance containing the text of the requirement, its unique identifier and the current state of the requirement.

REL Framework

The following libraries and tools are part of the REL framework:

rel_lib - library containing the implementation of REL: Parser and model validation is located there. The library can be embedded into different tool environments.
rel_cli - command line interface for REL, to parse a requirements model and check its validity.
rel_ls - language server implementation for REL, which can be used in IDEs supporting the Language Server Protocol (LSP), to get syntax highlighting, online validation and more for REL within the IDE.
vscode-ext - Extension for Vidual Studio Code, using the language server implementation to support REL in this IDE.
rel_py - python3 integration of REL, so that developers can use python language to write project-specific data exporters and validators for their requirements model.

Development Enviroment of REL Framework

The REL project uses Bazel as build environment.

Branch main is protected and pushes directly to the branch will be rejected. Create a feature branch and pull request, to get changes into main.

Every PR that is supposed to go into main is validated in CI via Github Action. The action builds all libraries and binaries of the framework, runs all test cases and validates REL's requirements with rel_cli

Getting Started

Getting Started Video

Prerequisites

The following tools are required to build and run REL:

Linux OS (REL framework has been tested with Ubuntu 20.04)
Bazel build environment (>=3.7)
C++ Compiler supporting C++17
Python 3.8 (to write custom Python scripts using REL python module)
Visual Studio Code (>=1.50) for IDE support via language server

Validate REL framework requirements

To process REL framework requirements, execute the following steps:

Clone this repository from Github
Build REL command line interface: bazel build //rel-cli:rel_cli
Run the binary with the following command: bazel-bin/rel-cli/rel_cli -r -v ./requirements/

Further Documentation

Developers Guide: Describes typical use cases and how to make the most out of REL for software projects.

Additionally, the following projects give an impression of the language on a larger scale:

folder test contains a couple of test models, which are used in integrations tests
Have a look at the requirements of REL itself, of course they are written in REL, too (eat your own dogfood!).

sscit/rel