search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Inconsistent language in UG sections #2642

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 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.

Sections of the UG have completely different instruction style from the other, which makes it disorienting to read. The use of you-language and level of formality and tone are fundamentally different across sections.

The language in earlier sections: Screenshot 2021-11-12 at 5.29.17 PM.png

The language in later sections: Screenshot 2021-11-12 at 5.30.19 PM.png

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

SvethaMahadevan commented 2 years ago

Team's Response

image.png

Doesn't classify as a bug since it doesn't hinder the reader in any way and they can still use the application without any issues based on instructions given in the guide.

Duplicate status (if any):

--