Skip to content

Requirement adding

Simon Hein edited this page Apr 8, 2024 · 8 revisions

Requirement adding Guidelines

Consistency:

  • Consistency across all requirements. The language and choice of words shall be consistent and remain so.

Levels of Requirements:

  • System Requirements
  • Software Requirements

UID Handling:

  • UIDs are freely selectable for development of the Requirements.
  • Final UIDs are distributed during the requirement finalization process.

Requirement titles:

  • Use short and terse requirement titles.

The short titles are easier to read and navigate when exploring the table of contents of a document which simplifies understanding of the overall document structure. Example: use "Reset Count" instead of "Counting Semaphores Exposes Ability to Reset Count to Zero".

Pull Request:

  • Adhere to the contribution guidelines of the Zephyr Project: https://docs.zephyrproject.org/latest/contribute/guidelines.html
    • As long as they are applicable to the requirements repository.
  • Avoid creating larger commits that contain both trivial and non-trivial changes.
  • Avoid moving and changing requirements in the same commit.
Clone this wiki locally