search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

User Stories inconsistent formatting #4307

Open nus-se-script opened 11 months ago

nus-se-script commented 11 months 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.

image.png

In this user stories table, one of the sentence is ended by a full stop, while the others are not, which shows inconsistent formatting of the table.

image.png

[original: nus-cs2103-AY2324S1/pe-interim#3293] [original labels: type.DocumentationBug severity.VeryLow]

chewjh1234 commented 11 months ago

Team's Response

Thank you for the observation.

We agree that it requires sharp eyesight and attention to detail to be able to spot the absence of full stops.

However, we disagree that this is a valid bug, for the following reasons:

  1. There are no requirements for the use of full stops in User Stories.

  2. The absence and presence of full stops at the end of every definition in User Stories does not hinder the reader, and it does not affect the readability of the User Stories section, in any way.

We would like to bring your attention to the CS2103T course website, which states that a documentation bug in DG/UG is only valid if it hinders the reader.

Screenshot 2023-11-20 at 2.47.23 AM.png

We do not think that full stops are important terms which are left out.

Therefore, we are rejecting this bug.

Thank you.

Duplicate status (if any):

--