search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Lack of Explanation in UG for Targets #815

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.

Screenshot 2022-11-11 at 5.38.32 PM.png

The UG section for targets just immediately dives into provision of syntax and commands to add , edit targets , etc without even explaining what are targets, hence as a user, I am unaware of what exactly target is, and what benefit/proposition it brings to me.

Screenshot 2022-11-11 at 5.41.39 PM.png As seen in the above picture, there's only a brief mention of the keyword 'spending targets' in the Introduction section, but that too is vague.

One recommendation could be a simple explanation at the start of this Targets section to explain what are targets, and a rough overview of the usefulness of this feature to the users.

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

penguin-s commented 1 year ago

Team's Response

No details provided by team.

Duplicate status (if any):

Duplicate of #657