#3715 accepted task

Add Requirements Engineering chapter to RTEMS Software Engineering Handbook

Reported by: Sebastian Huber Owned by: Sebastian Huber
Priority: normal Milestone: 6.1
Component: doc Version: 6
Severity: normal Keywords: qualification
Cc: Blocked By:
Blocking: #3703

Description

The chapter should cover the following topics:

  • Overview and introduction
  • Evaluation of tools for requirements management
  • Selected tool for requirements management
  • Evaluation of data models and formats for the requirements
  • Definition of data model and format actually used for the project (may overlap with tool)
  • Requirements management workflow used in the project
  • Requirements on requirements, e.g. derived from standards such as ECSS-E-ST-10-06C
  • Requirement identifiers used to ensure traceability

Change History (20)

comment:1 Changed on Mar 4, 2019 at 1:10:43 PM by Sebastian Huber

Status: assignedaccepted
Summary: Add Requirements Engineering chaper to RTEMS Software Engineering HandbookAdd Requirements Engineering chapter to RTEMS Software Engineering Handbook

comment:2 Changed on Mar 4, 2019 at 11:02:03 PM by Chris Johns

How does the quality of RTEMS and it's requirements depend on the evaluation and selection of the tools for requirement management? I can understand the quality of the requirements effecting the quality of RTEMS but not the tools used to capture them? Why have the process, ie a sort of log book, in the engineering handbook? I would have expected this document to contain the out come of the discovery process and not the process itself.

I am concerned adding these things just creates a liability for the project. Can an email archive can perform this task?

comment:3 Changed on Mar 4, 2019 at 11:06:15 PM by Joel Sherrill

I agree with Chris. A trade study of requirements tools shouldn't end up in the handbook. Perhaps our requirements for a tool.

  • open source
  • supports format XXX for interchange
  • supports links for requirement derivation
  • ...

comment:4 Changed on Mar 7, 2019 at 7:34:38 AM by Sebastian Huber

Yes, maybe this is not the best place for the tool overview. I though it would be helpful in case someone asks in two years, why did you use this, have you considered that, etc.? Should I add a ticket for the tool selection instead?

comment:5 in reply to:  4 Changed on Mar 7, 2019 at 9:00:27 PM by Chris Johns

Replying to Sebastian Huber:

Yes, maybe this is not the best place for the tool overview. I though it would be helpful in case someone asks in two years, why did you use this, have you considered that, etc.?

A brief rational can be helpful, but the details can be distracting. I feel the simpler and more direct this document is the more effective it will be.

Should I add a ticket for the tool selection instead?

Yes, it can links to mailing lists discussions and attachments and it is easy to link too.

comment:6 Changed on Jan 7, 2020 at 9:14:04 AM by Sebastian Huber <sebastian.huber@…>

In d412c5b/rtems-docs:

eng: Add Software Requirements Engineering chapter

Update #3715.

comment:7 Changed on Apr 2, 2020 at 7:47:16 AM by Sebastian Huber <sebastian.huber@…>

In 6f0bc56/rtems-docs:

eng: Add glossary terms

Define the following terms:

  • assembler language
  • C language
  • ELF
  • interrupt service
  • software component
  • software unit

Clarify:

  • task

Update #3715.

comment:8 Changed on May 5, 2020 at 5:37:31 AM by Sebastian Huber <sebastian.huber@…>

In d4ba908/rtems-docs:

eng: Update requirements engineering chapter

Update requirements engineering chapter due to the removal of Doorstop
as the requirements management tool.

Update the application configuration related specification items.

Update #3715.

comment:9 Changed on Jun 1, 2020 at 11:02:31 AM by Sebastian Huber <sebastian.huber@…>

In 59312aa/rtems-docs:

eng: Split up requirements engineering chapter

This allows to more easily generate the specification item section with
a script using specification items.

Update #3715.

comment:10 Changed on Jun 1, 2020 at 11:02:33 AM by Sebastian Huber <sebastian.huber@…>

In 23ab40d/rtems-docs:

eng: Add generated documentation of spec items

The documentation of the specification items is generated by an RTEMS
qualification tool from a specification of specification items.

Move non-generated content to "req-for-req.rst".

Update #3715.

comment:11 Changed on Jun 1, 2020 at 11:02:35 AM by Sebastian Huber <sebastian.huber@…>

In 459326c/rtems-docs:

eng: Update requirements tooling section

Update #3715.

comment:12 Changed on Jun 1, 2020 at 11:02:37 AM by Sebastian Huber <sebastian.huber@…>

In 9b269ad/rtems-docs:

eng: Add interface specification how-to

Update #3715.

comment:13 Changed on Jun 8, 2020 at 7:05:29 AM by Sebastian Huber <sebastian.huber@…>

In f547988/rtems-docs:

eng: Simplify wording for specification items

Update #3715.

comment:14 Changed on Jun 8, 2020 at 7:05:31 AM by Sebastian Huber <sebastian.huber@…>

In 0c43c52/rtems-docs:

eng: Add generic attribute key types

Update #3715.

comment:15 Changed on Jun 8, 2020 at 7:05:33 AM by Sebastian Huber <sebastian.huber@…>

In 0213e8e/rtems-docs:

eng: Add a specification type for actions

Add support to specify functional requirements for actions (functions or
macros) via a transition map of pre-conditions to post-conditions. This
will be the work horse for functional requirements. Generation of
corresponding validation tests is supported.

Update #3715.

comment:16 Changed on Jun 8, 2020 at 7:05:35 AM by Sebastian Huber <sebastian.huber@…>

In ca2f5e6/rtems-docs:

eng: Update specification how-to section

Update #3715.

comment:17 Changed on Jun 10, 2020 at 8:12:37 AM by Sebastian Huber <sebastian.huber@…>

In db3892b/rtems-docs:

eng: Update action requirement specification

Update #3715.

comment:18 Changed on Jun 17, 2020 at 7:11:35 AM by Sebastian Huber <sebastian.huber@…>

In 87a9478/rtems-docs:

eng: Clarify action requirement specification

Update #3715.

comment:19 Changed on Jul 3, 2020 at 8:34:03 AM by Sebastian Huber <sebastian.huber@…>

In 1bd14cd/rtems-docs:

eng: Reformat to maximize the text width

Remove extra "X" character in some labels.

Update #3715.

comment:20 Changed on Jul 3, 2020 at 8:34:05 AM by Sebastian Huber <sebastian.huber@…>

In 0c13e94/rtems-docs:

eng: Fix typo

Update #3715.

Note: See TracTickets for help on using tickets.