nus-se-bot
commented
7 months ago Team's Response
Same issue as #84 which has been addressed there.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Confusion about Employee ID and Task ID
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.
Issue and possible improvements: It is not very clear that what Employee ID or Task ID refers to in UG. For example, as shown in the first screenshot, "Example: list followed by delete 3 deletes the employee with id 3 inTaskMasterPro." Users might feel confused about if "id" refers to the number in red box or the number in green box in the second screenshot. It can be improved by adding a screenshot to better clarify it in UG.
[original: nus-cs2103-AY2324S2/pe-interim#74] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The screenshot from the UG explaining all the commands format at the top of the Features section shows that we have in fact clarified what the tester wanted us to clarify.
Additionally, we believe that it should be straightforward enough to know which ID to use as it is written explicitly in the view as Employee ID or Task ID.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
"The task id refers to the number shown in the displayed task list.". However, there are many numbers shown in the displayed task list. This sentence should be clearer, especially for a general audience who is not familiar with the concept of IDs.