Zephyr Project Requirements

Statement:

This repository contains a preliminary work on the Zephyr Project requirements.

The requirements are captured using StrictDoc.

See the Zephyr Safety Working Group Wiki for information on connecting to the team.

The guidelines around writing requirements are located here: Safety Requirements

1. Deployed Documentation

Statement:

The requirements documentation is available online at: https://zephyrproject-rtos.github.io/reqmgmt

2. System requirements

Statement:

The requirements shall be browsable and editable on all major operating systems that have Python 3.7+.

3. Getting started

Statement:

To install the requirements management tool:

pip install strictdoc

To generate the requirements documentation in HTML format:

strictdoc export .

To browse/edit the requirements using StrictDoc's web interface:

strictdoc server .

To generate uid's for new written requirements use the command:

strictdoc manage auto-uid .