search

willyamped / pe

0 stars 0 forks source link

Visuals in UG are not well integrated into explanation #13

Open willyamped opened 3 years ago

willyamped commented 3 years ago

Screenshot 2021-11-12 at 5.36.02 PM.png

Perhaps, the screenshot could have been annotated to show "Command Box", "Result Box", etc.

soc-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

User Guide does not include an application layout

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

I consider this a documentation bug of your User Guide as:


Use of visuals

  1. Not enough visuals e.g., screenshots/diagrams

As a whole, I feel that the User Guide could have more images of the application to show the relevant commands in action.

However, most importantly, I feel that an application layout would be crucial for a User Guide to introduce the respective parts of the application's GUI to new users, especially considering the application has about 4 to 5 different compartments where data can be shown.

Severity is Medium as it affects all users (everyone is a newbie at one point), and the inconvenience is not very minor as they have to learn the application's layout themselves.

[original: nus-cs2103-AY2122S1/pe-interim#4045] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Throughout the guide, we have visual aids that help point the user to the respective parts of the UI if we feel that it would be necessary or confusing for the reader.

Furthermore, we believe our target users (Professors of CS1101S), would be able to figure out which part of the UI we are describing. The names we give each portion of the UI are also rather self-explanatory.

As such we have shifted this to severity low.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]