soc-se-bot
commented
6 months ago Team's Response
Thanks for your bug report!
We have 1 main reason why we did not include sample outputs for results and solution.
1. The descriptions of these features are considered to be sufficient for understanding.
Hence, for these features, sample outputs are trivial since it is not a requirement to include them in the UG (similar to how we omit getter and setters in class diagrams)
Description of results Feature:
Description of solution Feature:
As seen from the descriptions above, results and solution only serve as the "getters" for results and solutions respectively, so it should be intuitive the commands will display the results/ solutions (i.e expected outputs).
This is in comparison to more complicated/ unique features like timed mode, whereby the description may be insufficient to convey fully what the feature does, and where the sample output may not be intuitive (i.e. try to imagine what you would see if you "have entered timed mode" vs "the solution will be displayed")
Description of timed mode Feature (UG page 5)
Sample Output of timed mode
In addition, note the textbook's deliverables for UG:
Items for the Tester to Verify
:question: Issue response
Team chose [response.NotInScope]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Many of the functions in the user guide does not have a sample output. Would be good to have sample output to indicate to user what they are supposed to see if they are using the program correctly.