naz019 / pe

0 stars 0 forks source link

The order of commands listed in user guide is confusing #10

Open naz019 opened 2 years ago

naz019 commented 2 years ago

Instead of having commands like view and find being in the earlier portions, commands like add strength should be first so that users can follow along with the guide to avoid confusion

soc-pe-bot commented 1 year ago

Team's Response

Layout issues. As it does not affect the reader from understanding the instructions, we believe it is severity "Very Low".

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: This layout issue present problems beyond cosmetic ones. While individual commands may be understanble, the ordering of commands significantly impacts the overall coherence of the user guide and prevents the user guide from efficiently allowing the user to get the app up and running properly. The user guide's purpose is to help the user and part of that is having a structure that is easily understandable. With the current ordering, overall understanding of the UG is negatively impacted and inconveniences all users who refer to it.