[PATCH 0/2] Generate documenation of specification items

Sebastian Huber sebastian.huber at embedded-brains.de
Thu May 28 09:14:07 UTC 2020


I worked on the RTEMS qualification tools in the last couple of weeks
and I am now able to generate the documentation of the specification
items from specification items:

https://git.rtems.org/sebh/rtems-qual.git/tree/spec/spec

These items can be also used to verify that the specifications items
have the right format and to some degree that the attribute values are
sane.  Using specification items to specify specification items has the
benefit that the documentation and the means to verify that the items
have the proper format are always synchronized since the same data
source is used.

Specification item types can be recursively defined.  This makes it
possible to verify that the specification items that specify
specification items have the right format.

For the generated document see:

https://ftp.rtems.org/pub/rtems/people/sebh/eng2.pdf

The updated documentation covers also the items for the new build
system.

Sebastian Huber (2):
  eng: Split up requirements engineering chapter
  eng: Add generated documentation of spec items

 eng/glossary.rst         |    6 -
 eng/index.rst            |    2 +-
 eng/req-eng.rst          | 1282 ------------
 eng/req/index.rst        |   91 +
 eng/req/items.rst        | 4308 ++++++++++++++++++++++++++++++++++++++
 eng/req/management.rst   |   76 +
 eng/req/req-for-req.rst  |  394 ++++
 eng/req/tooling.rst      |  149 ++
 eng/req/traceability.rst |   77 +
 9 files changed, 5096 insertions(+), 1289 deletions(-)
 delete mode 100644 eng/req-eng.rst
 create mode 100644 eng/req/index.rst
 create mode 100644 eng/req/items.rst
 create mode 100644 eng/req/management.rst
 create mode 100644 eng/req/req-for-req.rst
 create mode 100644 eng/req/tooling.rst
 create mode 100644 eng/req/traceability.rst

-- 
2.26.2



More information about the devel mailing list