suwoons / pe

0 stars 0 forks source link

Grammar and formatting in DG #14

Open suwoons opened 4 years ago

suwoons commented 4 years ago

This is very minor, but for the sake of consistency, it might be better stick with points that all either start with a capital letter or not. This is reflected in other parts of the DG as well.

image.png

The headers and content of such tables should be standardised as well, to make the DG appear neater and more consistent. It would also help the DG be easier to understand.

image.png

Combining the header with the contents, the first row would translate to "So that I can so that I can...", the second row is "So that I can I won't have to..." and the third row is "So that I can focus on..".

nus-pe-bot commented 4 years ago

Team's Response

Thanks for the suggestion. Even though this is very minor, we agree that this affects the quality of documentation. Therefore, we are accepting this as a bug.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: [replace this with your reason]