Software Requirements

Requirements for mlx.traceability

System shall implement a plugin for the sphinx documentation system. It shall add tracebility within the documentation.

The plugin shall allow for splitting the documentation in parts.

A documentation part shall have a unique identification.

A documentation part shall have a optional brief description.

A documentation part shall have optional content. The content shall be parseable reStructuredText (RST), and passed through the configured sphinx parser/renderer.

It shall be possible to add attributes to the documentation parts. Attributes have a key and an optional value. The set of attributes and the validness of the attribute values shall be configurable.

It shall be possible to link documentation parts to other documentation parts. The set of relations shall be configurable.

When a documentation part <A> is related to a documentation part <B> (forward relation), the reverse relation from documentation part <B> to documentation part <A> shall be automatically created.

It shall be possible to generate a list of documentation parts matching a certain query.

It shall be possible to calculate the coverage for a certain type of relation between documentation parts.

It shall be possible to query the relations between documentation parts. It shall be possible to generate overview matrix of these relations.

It shall be possible to query the relations between documentation parts. It shall be possible to generate overview tree of these relations.

An overview table of the attribute values for documentation parts shall be generated.

The plugin shall be able to allow configurability of the order of items’ attributes.

The plugin shall be optimized for performance to minimize its impact on the documentation’s build time. For example, unneeded sorting should be avoided.

Traceability matrix

Tree of requirements

Design coverage

Trace requirements to design

Statistics: 15 out of 17 covered: 88%

Requirement

Design

Design coverage chart of functional requirements

_images/piechart-4b1634f81a3594aadd4807612c4b06fae9c2647e258b9c3e3bd7aa158a55acdf.svg

RQT

DESIGN

Uncovered
Covered

Test coverage

Trace requirements to test cases

Statistics: 13 out of 17 covered: 76%

Requirement

Test case

Trace requirements to test case reports

Statistics: 6 out of 17 covered: 35%

Requirement

Test case

Test case report

Result

pass

skip

pass

error

pass

skip

pass

PASS

ERROR

Chart fetching third label from defaults

_images/piechart-b96d9787fd07c3e88a2b2b055e441ac2dd6984763831c87482a0a66ce646ea70.svg

Statistics: 13 out of 17 covered: 76%

RQT

[IU]TEST

[IU]TEST_REP

not covered
covered
executed

Test coverage chart with test results, based on the :targettype: option

_images/piechart-fc6084650c49954b4d1c58989bce8087e36159c864f3889c46846d53b50b0811.svg

Statistics: 13 out of 17 covered: 76%

Requirement

Test case

Test case report

Result (relationship)

not covered
covered

passes

fails

fails

passes

passes

fails

passes

passes

skipped

skipped

passes

skipped

skipped

Test coverage chart with test results, based on the :result: attribute

_images/piechart-c6029e608327e4595ad471bfddd9ebcdd68bf4d593b6afdfe5fa45c593f072c0.svg

Statistics: 13 out of 17 covered: 76%

Requirement

Test case

Test case report

Result

uncovered
covered

pass

has report

skip

pass

ERROR

error

pass

PASS

ERROR

pass

pass

skip

skip

Test coverage chart with test results, based on the :targettype: option (in bad order)

_images/piechart-2f8b07ba7024dd5398d7a813329b4aba65c473a920bd15687e3b3b3bf1c77fd3.svg

Statistics: 13 out of 17 covered: 76%

Test cases as source using sourcetype to label with the :splitsourcetype: flag

_images/piechart-f9467db77e89b044a5fe103cca2169f46b9adfc6ca87bf015a81e456609ec8dd.svg

Statistics: 9 out of 35 covered: 25%

All uncovered as the bad sourcetype results in 0 links

_images/piechart-a31b7750a490575b2420b944cadd5a0a278f24718b53b385e1931ee3f1667cd2.svg

All uncovered as there is no direct relationship

_images/piechart-3af740a7ddb75b2bab89b095075b6a0f673792dfdfaeb75910082ca56ee2a29c.svg

Chart with only one color configured to trigger warning

_images/piechart-ab3db1023556ff8d3017fbfff25a9f3434876a89db0dd969437cb681653cb8eb.svg

Chart without any items: no image or warning shall be generated

Statistics: 0 out of 0 covered: 0%