Lack of screenshots in UG

[minnibb]

The UG contains only one screenshot which is not sufficient to illustrate the application features and usage. It makes it harder for users to understand the application

Functions like assignment especially could benefit greatly with screenshots to show what the user should expect the outcome to be.

[nus-pe-bot]

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Agree with the additional screenshots would help to illustrate the usages better, however, especially for the stated assignment commands, it is explicitly stated in the UG that it would be displayed as a different colour with regards to its completion status, therefore, we think that this warrants a lower severity as it does not impact the reader's usage of the app too much and the reader would still be able to use the app as per normal.

Items for the Tester to Verify

❓ Issue severity

Team chose [severity.Low]
Originally [severity.Medium]

• I disagree

Reason for disagreement: The lack of screenshots in a CLI GUI application causes more than a "minor inconvenience" to users, particularly new users who are learning the application. From the TutorTrack UG's own description, this app targets tutors who may not be technical experts. Without visual guidance, users will experience "occasional inconvenience" when:

1. Learning command formats and syntax
2. Understanding expected outputs
3. Troubleshooting errors
4. Navigating between different views (student vs. lesson lists)

This meets the definition of a medium severity as it causes "occasional inconvenience to some users" during normal usage scenarios like learning the application and dealing with errors, while still allowing them to eventually use the product. The team acknowledges screenshots would "help to illustrate the usages better," confirming this impacts usability beyond rare situations.

---