Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Position of help command within User Guide #756

Open
nus-pe-bot opened this issue Nov 16, 2024 · 1 comment
Open

Position of help command within User Guide #756

nus-pe-bot opened this issue Nov 16, 2024 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Nov 16, 2024

Within the User Guide, the placement of the help command causes slight confusion.

It makes more sense to put it at the top to make the user guide more new-user friendly. I struggled to know all the possible commands and functionalities when first using the app. Placing the help command at the top would make it easier for use for a new user to the application.


[original: nus-cs2113-AY2425S1/pe-interim#742] [original labels: severity.Low type.DocumentationBug]
@NigelYeoTW
Copy link
Contributor

Team's Response

Dear tester,

After discussion with the team, we have downgraded the severity to very low and choose to categorize it as not in scope.

The following are the justification:

  1. Seems to be a layout issue as defined by very low severity.
  2. We feel that the point of the user guide is just to give users information on different commands. It is the user's responsibility to navigate to the sections they need help with. There are hyperlinks given in the table of contents at the start of the user guide. The section on help command's purpose is to explain help command's functionality and not to give a summary. Maybe you were referring to the command summary. However, we have followed AB3 layout to place it at the end which seems reasonable to us.

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment