search

APZH / pe

0 stars 0 forks source link

Difficulty identify and separating actual commands from their explanations #11

Open APZH opened 3 years ago

APZH commented 3 years ago

image.png

When I was reading the UG, I found it hard to identify where the commands were as there was no clear difference in the font type and separation between the actual command itself and the explanation as shown in the image above.

One suggestion I could thing of would be to BOLD the commands and add a dash in between the command and it's explanation. For example, the new game command could be written as follows.

newgame (bolded) - Start a new game. The system will give you a string of user number that is usedto continue the game next time.

nus-pe-bot commented 2 years ago

Team's Response

I think it is because the template we choose is not very suitable, thanks for advice.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]