JunCheng98 / pe

0 stars 0 forks source link

Documentation for find is wordy and has insufficient images #6

Open JunCheng98 opened 3 years ago

JunCheng98 commented 3 years ago

The documentation for find in page 17 is wordy, has too much explanations and hard to digest. Suggest including more screenshots as examples so users can follow the explanations more easily.

nus-se-bot commented 3 years ago

Team's Response

While it may be wordy to some, it is already the most concise it can get, without leaving out any crucial information. There are examples given are intuitive and comprehensible, and thus make the points much easier to digest.

If screenshots were used, it may seem extremely repetitive, since the differences between each screenshot would be relatively small and may confuse the reader further. Adding screenshots may result in visual clutter instead, preventing the user from understanding the information quick enough, as opposed to reading all the worded explanations.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While I agree that introducing too many images would cause visual clutter, my suggestion was to add some images to complement the explanation. Even adding 1 or 2 images would be sufficient to illustrate a find example.

One example of what the team did was to add a screenshot in section 4.3.1 and 4.3.2 for the add expense and edit expense commands to illustrate examples, so I find it more consistent for the UG to have a screenshot for the find command section to illustrate an example, especially since the find command has so much information cluttered together. Adding 1 or 2 screenshots here would make the section more user-friendly in comparison to hitting readers with a wall of text.