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

UserGuide Introduction not starting exactly where a new User would. #130

Closed
nus-pe-script opened this issue Nov 2, 2018 · 2 comments
Closed
Assignees
Labels
type.bug A bug type.docs Something related to either UG or DG

Comments

@nus-pe-script
Copy link

Please describe the problem
Hey guys! What I personally noticed that was your User Guide started immediately from the QuickStart with an image of pre-input data and some instructions about help Command, list etc.

It then continues on to the Features portion about each Command and its format and interface, before then arriving at Security, which is your login register etc.

What the problem here is, that new Users following your QuickStart guide would actually be greeted by your login page, and hence when I was reading through your UserGuide and following said instructions I was stuck I was led to believe I could immediately type help or list and tried those before failing. It was only after I tried to scroll through the user guide, past features then to security did I realise I had to register or login.

Describe the improvement you'd like to suggest
What I would suggest would be either to edit your QuickStart guide to really be from a perspective of a new User, therefore, instructing them to register and logging in before telling them about the available commands such as help, list etc. Also, your features portion in the UG would then nicely come after.

Either that or you guys could also put Security at the top, so that Users would find it easier to solve the logging in issues immediately without having to scroll that much further down!

Additional context
Just a suggestion, and it's not anything pertinent to the execution of your application. Just something that would make your User Guide, QuickStart guide and App more User/Beginner friendly.


Reported by: @lucdx
Severity: Low

[original: nusCS2113-AY1819S1/pe-1#398]

@nianfei97 nianfei97 added type.bug A bug type.docs Something related to either UG or DG labels Nov 2, 2018
@bennchong
Copy link
Collaborator

Noted. I'll add login info into the quickstart section

@bennchong bennchong self-assigned this Nov 4, 2018
@nianfei97
Copy link

Addressed by #152, but if there's more things you want to add there, go ahead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.bug A bug type.docs Something related to either UG or DG
Projects
None yet
Development

No branches or pull requests

3 participants