Skip to content

[Feature]: Add Optional Requirements Justification #93

@Malcolmnixon

Description

@Malcolmnixon

Problem Statement

Requirements are often more valuable when coupled with a justification explaining why the requirement exists; however the ReqStream yaml format doesn't have a recognized pattern for capturing justifications

Proposed Solution

Add an optional justification field to each requirement. Additionally the tool should grown an option to generate a new type of requirements justification markdown which follows the same section structure as the requirements export, but contains the requirement ID, Title, and Justification text.

Note that examples of justifications should use the yaml multi-line format. In fact examples probably shouldn't use the double-quotes unless its for symbol names such as tests or other requirements.

Alternatives Considered

No response

Usage Examples

Benefits

The presence of justifications in requirements may help developers (both human and agent) understand the context.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

Remember that supporting documentation needs to be updated as well. Additionally the ReqStream requirements themselves should be enhanced with justification comments and the requirements justification document published to PDF.

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful

Metadata

Metadata

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions