doorstop icon indicating copy to clipboard operation
doorstop copied to clipboard

Add option to check derived requirements have rationale

Open robertberrington opened this issue 11 years ago • 5 comments

This is a common Requirements Standards item. DO-178 requires this, I'm pretty sure.

robertberrington avatar Aug 22 '14 15:08 robertberrington

Currently, Item does not have a rationale field. I'll have to think about whether this should be added or this feature should be left to custom project hooks.

jacebrowning avatar Aug 22 '14 17:08 jacebrowning

I could go either way on this. Recently I moved all my "Notes", "Comments" and "Rationale" directly into the item's text. It would seem straight forward enough to have a project hook that scanned derived = TRUE, the searched item.text for rationale followed by text.

The advantage is that adding "Notes", "Comments" and "Rationale" to item.text is that it is included in the review and link status, which could be an important aspect of requirement.

On the other hand, many Requirements Standards would required any "derived requirement" to have a rationale since it is not linked to anything ... it should have a reason to exist.

Either way, you might consider adding a "check for derived requirement has rationale" option to the standard checks regardless of if the rationale is in an item.text or item.rationale field.

$ doorstop --no-rationale-check "do not WARN if rationale is missing from derived requirements"

This allows a rationale check to be elevated to ERROR with the --error-all option.

robertberrington avatar Dec 03 '14 15:12 robertberrington

This all sounds worthwhile to me. I'll consider this a request to:

  • add item.rationale that only gets published if it exists
  • add a check for a rationale on derived requirements
  • add an option --no-rationale-check to disable this check

jacebrowning avatar Dec 03 '14 15:12 jacebrowning

Does the 'ready' tag indicate that this request has been implemented? Because I don't think it has, at least it's not merged.

I was looking for a way to specify a rationale that is separated from the text, this would do the job.

blastur avatar Mar 01 '17 19:03 blastur

ready means that the story is ready to be worked on: https://waffle.io/jacebrowning/doorstop

jacebrowning avatar Mar 01 '17 20:03 jacebrowning