timleow
commented
1 year ago Team's Response
It is easy for the person to infer from the data and the response message what each prefix refers to.
The intention was not to have a comprehensive explanation of the commands here, and for the user to get an idea of how to work with TaskHub based on the real-life details that they have.
For the details of the prefixes and explanations of each command, they are directly in the next section (Features) and we believe that they could simply refer to it if the comprehensive explanations were what they were looking for.
We would like to put this as NotInScope since it is a valid point that the commands in this section are not completely explained, but that is also the intention of the Quick Start section - to show the user how they might use certain commands based on the scenario rather than explain every command in detail.
Duplicate status (if any):
--
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.
While it's very nice that an example run-through is shown for any prospective or first-time users, it's possible that not explaining what the command means might detract from the purpose. I.e., from this example, I know how to add this specific person, but I'm not entirely sure what
t/,n/,etc. mean and have to read it later.The fact that the user can just read it later and infer it from earlier sections means that this isn't really a severe issue, but detracts from the utility of what is otherwise a good addition.
In effect, the semantic meaning of these prefixes are slightly obfuscated.
[original: nus-cs2103-AY2324S1/pe-interim#102] [original labels: severity.Low type.DocumentationBug]