search

JasonCP14 / pe

0 stars 0 forks source link

The overall structure of the features which might hinder the reader #6

Open JasonCP14 opened 2 years ago

JasonCP14 commented 2 years ago

In the UG, tags are placed after the contact and todo commands. This may hinder the user, as most commands may use tag, but tags are placed at the last order. There may be a link to the tag command instructions, but it should be better to put it at the top to improve fluency of the UG

image.png

nus-se-script commented 2 years ago

Team's Response

Thank you for your input. But we deliberately structure it that way because our main features are Contact and Todo Management, therefore they should come first. Tag Management is for users to integrate between these two functionalities. It will be more confusing for the user if we introduce tag commands first without explaining the context behind that. Since you can only add a tag to an existing contact and todo, which means the flow should be creating contact and todo first before creating a tag. This is also a duplicate of another issue that also suggested to move tag command to the top.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Order of Commands in UG could be improved

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

image.png

I understand that a modification has been made to how tags are initialised in a way that it has to be created first before it can be used to tag to a person. I would think that it would greatly help with reader understanding if the add tag command is introduced first

image.png

The sample command given in the screenshot above will not work since the tag "owesMoney" has not been created

[original: nus-cs2103-AY2223S1/pe-interim#1280] [original labels: type.DocumentationBug severity.Low]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for your input. However, we do not think that it is a bug. Because we want to organize it in such a way that we prioritize Contact and Todo Management first (our main features), and then followed by Tag and Customisation that integrate these two main features. Furthermore, we also always link the user to how to add the tag inside the Contact and Todo Commands, as shown in our UG below:

image.png

We think that it will be more confusing if we put the Tag first, without introducing a context on what the tag could be used for (labelling contact and todo). Furthermore, a tag can only be used on the contact and todo after the contact and todo have been created. Further strengthen the logical flow that user need to learn how to add contact and todo first before creating tag.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If that is the case, then perhaps the UG can specify which tags have been created by default, because as a new user, I want to try using the features in the app one by one, and I am expecting that doing that in the same order as the UG will help me understand the app better.