search

SaiChaitanya13 / pe

0 stars 0 forks source link

Formatting of user stories #11

Open SaiChaitanya13 opened 1 year ago

SaiChaitanya13 commented 1 year ago

image.png

Formatting of user stories could be done in the same page so we don't have to go to the previous page to refer.

soc-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Many areas where the formatting is done poorly

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.

There are many instances where the reader would have to go to the next page for the same section and the formatting makes the reader need to refer to the previous page.

Below are a few instances.

image.png In UG, the command "Unignore transaction" row goes onto the next page, therefore the example commands are shown on the next page and if the user is on the next page, (s)he may not know what action unignore 1 and unignore 2 are referring to.

image.png

Formatting of user stories in DG could be done in the same page so we don't have to go to the previous page to refer.

image.png The title "Glossary" in DG is in the previous page while the table is in the next page.

[original: nus-cs2113-AY2223S2/pe-interim#2226] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Does not hinder the reader, when viewed in pdf the content still remains clear. The alternative would be to leave a lot of white space between each section which arguaby can hinder the reader more.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** It's a duplicate. But I still feel that the user stories should at least be on the same page for the same row. This would help the reader better read.