search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Unnecessarily long explanation for streaks #518

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

writes about how goals and streaks are handled for too long and is too complicated image.png

[original: nus-cs2103-AY2021S2/pe-interim#518] [original labels: severity.Medium type.DocumentationBug]

ivantjh commented 3 years ago

Team's Response

Hi there, thank you for your feedback. The team has reviewed this report and has decided that this is not a valid bug. We also disagree with the severity and think that it should be Low as users can choose to just read a single example if they can understand Streaks after that. We will only talk about the lengthy streak explanation because we found a similar issue posted by you that reported a bug with the lengthy explanation on goal deadlines (#517).

The team found that the explanation was adequate and necessary for the user to fully understand the concept behind streaks. As you can see, the Streaks Dashboard takes up only two paragraphs. All the information needs to be there so that users will understand what is a Streaks Dashboard and how to display it. There isn't any repeat information here.

The next two paragraphs are on how streaks are calculated, which is totally different from the Streak Dashboard explanation. All the information is necessary to ensure that any user reading it will really understand how streaks are calculated. We did not want to rely on the users' guesswork, hence we put in a longer explanation with examples.

Duplicate status (if any):

--