RTEMS Requirement Management Tools

[Chris Johns]

On 23/3/19 7:17 am, Joel Sherrill wrote:
> 
> 
> On Fri, Mar 22, 2019 at 8:03 AM Sebastian Huber
> <sebastian.huber at embedded-brains.de <mailto:sebastian.huber at embedded-brains.de>>
> wrote:
> 
> 
> 
>     On 21/03/2019 14:32, Joel Sherrill wrote:
>     > 5. Is it possible to have custom fields? I worked on a project where
>     > requirements were
>     > tagged with project phase and HW/SW. Alternatively, can we add
>     > comments to the YAML
>     > files. Or who cares since the author information is in git.
> 
>     According to the Doorstep documentation:
> 
>     https://doorstop.readthedocs.io/en/latest/reference/items/
> 
>     "Extended attributes
> 
>     In addition to the standard attributes, Doorstop will allow any number
>     of custom attributes (key-value pairs) in the YAML file. The extended
>     attributes will not be part of a published document, but they can be
>     queried by a 3rd party application through the REST interface or the
>     Python API.
>     Example:
> 
>     In this example, an extended attribute invented-by is added to the item.
> 
>     invented-by: some.guy at email.com <mailto:some.guy at email.com>"
> 
>     Use of a standard format such as YAML is nice since it enables us to
>     read these requirements files quite easily.

+1 It helps mitigate tool risk if the data can be parsed in a standard way.

> This is awesome! Chris and I discussed that it would be desirable to generate
> our requirement documents in Rest. If this is implemented, then that tool could
> know the extended attributes.
> 

+1

>     [...]
>     > Is the documentation and/or tutorial sufficient to get us started?
>     > Whatever tool is adopted,
>     > common tasks will have to be documented like we do with git use.
> 
>     Similar to the Git overview in
> 
>     https://docs.rtems.org/branches/master/eng/vc-authors.html
> 
>     we need something similar for the requirements tool.
> 
> 
> +1 

+1

Chris