[Feature]: Design Documentation and Requirements #118
Description
Problem Statement
To facilitate formal reviews, the project needs design documentation and requirements split out into separate files.
Proposed Solution
For the design documentation, what's needed is a docs/design folder which should be structured as a pandoc folder with the usual files (title.txt, definition.yaml, introduction.md) but also with model.md and serialization.md. These files should have the design details of the TestResults model and the Serialization approach, and these files should be added to the corresponding reviewmark review sets.
For the requirements, what's needed is a docs/reqstream folder. In this folder should be the ReqStream model.yaml, serialization.yaml, runtime.yaml, and ots-software.yaml with the appropriate requirements transferred from the root requirements.yaml file. In turn the requirements.yaml file should include these separated files (see https://github.com/demaconsulting/ReqStream/blob/main/README.md for details). The model and serialization requirements should then be added to the corresponding reviewmark review sets.
The result of this should be that the requirements don't change, but there is detailed design documentation and the formal reviews can be performed with the review-sets containing the requirements, design, code, and tests.
Alternatives Considered
No response
Usage Examples
Benefits
This should result in complete formal reviews of the core functionality.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
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