Shauryan123 / pe

0 stars 0 forks source link

Showing the help window image for the help command would be helpful #29

Open Shauryan123 opened 5 months ago

Shauryan123 commented 5 months ago

Screenshot 2024-04-19 at 5.37.02 PM.png

There is no picture of the help command window which could potentially benefit the reader to see how the UI looks like

nus-se-script commented 5 months ago

Team's Response

Thank you for your suggestion. However, this is non-essential since the user could simply type the help command and observe how the help window looks like. Thus we will be marking this as not in scope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I disagree with the development team's decision to classify the lack of an image for the help command window as "Not in Scope." Providing a visual example of the help window in the user guide is essential for a complete understanding of the application's functionality without needing to interact with the software first. This is particularly beneficial for users who are reading the documentation in environments where they may not have immediate access to the application (e.g., while studying or in a planning meeting) or for those who are evaluating the software's features before deciding to use it.

Visual aids are a critical component of effective documentation, as they help to reduce cognitive load and provide immediate, clear context about how interfaces look and function. The absence of such visuals can hinder the reader's ability to fully grasp the functionality and appearance of the application, requiring them to go through additional steps just to obtain information that could have been easily conveyed through the documentation. This not only slows down the learning process but also makes the documentation less efficient and user-friendly.