Screenshots could provide more context

[chaaaaun]

For commands that require information from both lists, it might be clearer if the screenshots provided show the entire app window. For example, for lookup:

While the change in person list is shown, the actual article that is being looked up is not shown. It would be helpful if users could see exactly how the article looks like such that performing the lookup would lead to the given result.

[nus-pe-script]

Team's Response

Agreed, it could show the full app at the beginning to be clearer. I changed the severity to very low as this should not hinder the reader.

Items for the Tester to Verify

❓ Issue severity

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

• I disagree

Reason for disagreement: I feel that the very fact that the team has acknowledged that the screenshots "could be clearer" shows that this is not a purely cosmetic issue, and warrants a higher severity than VeryLow.

Based on the second bullet point in the UG guidelines below, I would make the case that omitting the very list that the command is operating on shows that the visuals do not fit the explanation. For example, based on the screenshot in the original issue, readers will likely have to put in additional effort to understand the effect of looking up index 2, when the item at that index isn't even shown.

---