search

yeo-yiheng / pe

0 stars 0 forks source link

Appendix too chunky #13

Open yeo-yiheng opened 2 years ago

yeo-yiheng commented 2 years ago

Appendix in UG is too chunky and too little white spaces or other elements

nus-se-script commented 2 years ago

Team's Response

Sorry there is no appendix in UG and DG appendix contains all necessary components with the required format by CS2103T textbook, we think that there is no way to add more whitespaces as well.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As a reader, the appendix in the DG is too chunky as a lot of the sections are just a large chunk of text with no emphasis using bolds / italics / underlines. Taking the undo/redo feature section as a reference, it would be nice to include certain examples or pictures for the readers to follow the issues faced whilst implementing the feature.

It would be better to have certain diagrams to show some of the problems faced instead of it all being text because it is easy for the reader to be lost in the paragraphs. Even if it had to be all text, highlighting the main points would be really great in aiding the reader to pick out the important points of the paragraph.