Skip to content

Coverage Policies per artifact type, incl. "any one of" alternatives #644

Open

Description

@matjeromin

Hey, we are using OpenFastTrace to trace requirements through our validation documents and really like how it works, thank you for the project! This request is about making the expected coverage easier to state and check.

Is your feature request related to a problem? Please describe.
Needs: is declared per item, so nothing checks that the declarations make sense as a whole. If an author forgets a Needs: line, or writes the wrong types, OFT reports no defect. The traceability rules of a project live only in the authors' heads (or in tooling that generates the Markdown).

Example: we want every user requirement (urs) to be covered by a system requirement (srs) or by an entry in the user manual. Today we cannot express "any one of several types". Needs: srs, manual demands both, and Needs: srs alone flags a requirement that is correctly covered by the manual.

Describe the solution you'd like
A small, project-wide policy file (e.g. oft-policies or similar) that states which artifact types must be covered by which others, with alternatives. For our setup:

urs  -> srs | manual
srs  -> test-spec
test-spec -> test-report

OFT would then:

  • treat these rules as the expected Needs for every item of that type, so items don't need to repeat them;
  • report an item as defective if it is not covered according to the rule (satisfied by any one alternative);
  • ideally report a Needs: declaration in an item that contradicts the policy.

Describe alternatives you've considered

  • Declaring Needs: per item, as today. This cannot express "A or B" and is not checked against any rule.
  • Generating the Markdown from a script that writes correct Needs: lines. This works, but the script then becomes the source of truth. We would prefer to write Markdown directly and have OFT check the declarations.

Additional context
Our chain:

  • user requirements -> system requirements
  • risks -> controls
  • controls -> system requirements
  • system requirements -> test specification
  • test specification -> test report

We run OFT 4.9.0 in CI over documents that are otherwise written in LaTeX. Related: #353, #474.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions