Alteqa / pe

0 stars 0 forks source link

Enhancements for DG very cluttered #20

Open Alteqa opened 2 months ago

Alteqa commented 2 months ago

image.png

soc-pe-bot commented 2 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Points in appendix very dense and hard to read (UG)

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.


Description: The points in the appendix under enhancements are all lumped together and difficult to read.

The points are all joined together and makes it difficult for readers to see the important points. Maybe could split each point into sub-bulleted points to aid readability! :)

Screenshots

pointsclunky.png


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

Their Response to the 'Original' Bug

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

Thank you for the feedback, we tried to concentrated enhancement together for an easier read but it turns out people prefer spead-out bullet points as well.

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.NotInScope`] - [x] I disagree **Reason for disagreement:** This is definitely a documentation bug in the scope of the DG. This is because having a difficult to read developer guide is a serious cosmetic issue that affects the basic functionality of the guide which is to help developers to understand how to work with the app. Therefore, formatting issues should not be considered not in scope.