Requirements for requirements management tool

[stanislaw]

This discussion is to collect some of the requirements that I find on the internet.

---

One almost random note from a SW engineer:

All documentation is a huge mess, and the the Microsoft Word status quo makes it difficult to have any progress. I think 20 years ago we already had this exact issue

Missing or out of date ToC is my number 2 most annoying thing about documentation (after the impossibility to properly parse a pdf/word with a script and lack of clear version control)

[stanislaw]

These are RTEMS requirements for a requirements management tool as found in the RTEMS Qualification Data Package and RTEMS Software Engineering respectively:

• Traceability between requirements
• Requirement Control (deleted, added, modified)
• Version control (git/svn)
• Export to pdf/xml/html
• Traceability to Architecture/Source code/Tests
• Constraints to Requirements
• Requirement analysis
• Integration with Python
• ReqIF standard import/export
• Graphical User Interface
• Database independent
• Requirements information (ex: author, effort, type, status, priority)

and

To manage requirements some tool support is helpful. Here is a list of requirements for the tool:

• The tool shall be open source.
• The tool should be actively maintained during the initial phase of the RTEMS requirements
  specification.
• The tool shall use plain text storage (no binary formats, no database).
• The tool shall support version control via Git.
• The tool should export the requirements in a human readable form using the Sphinx
  documentation framework.
• The tool shall support traceability of requirements to items external to the tool.
• The tool shall support traceability between requirements.
• The tool shall support custom requirement attributes.
• The tool should ensure that there are no cyclic dependencies between requirements.
• The tool should provide an export to ReqIF

[stanislaw]

Another good source of requirements is the ReqIF v1.2 spec.

[stanislaw]

Export to GraphViz:

Would be interesting to visualise the SDoc tree using https://graphviz.org/Gallery/directed/unix.html.

[stanislaw]

See also Doorstop is not a library #471.

[stanislaw]

It might be interesting to look at the ROS's package quality levels: https://ros.org/reps/rep-2004.html#quality-level-1.

[stanislaw]

Relevant document: Statement of Work - ECSS Requirements Management System - [E-RMS]