search

GWphua / pe

0 stars 0 forks source link

UG: Technical Jargon in Introduction. #18

Open GWphua opened 2 years ago

GWphua commented 2 years ago

The average reader would not know what is a CLI/GUI. Adding in these does not give any incentive.

Maybe adding a link would help readers to understand.

image.png

nus-pe-bot commented 2 years ago

Team's Response

The application's target audience are hotel staff in charge of checking in and out guests. The explanation of what CLI and GUI means have no additional benefits.

Furthermore, we have included screenshots in the majority of the UG to show the application's usage without heavy reliance on an implicit understanding of what is a CLI or GUI. Thus the concepts of CLI and GUI are only limited to this introduction paragraph and any explanation of the CLI and GUI are not necessary due to the lack of further reliance on those terms in the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Still, it is essential to leave out technical jargons for the readers. This is to prevent non-tech people from getting confused. This point has even been specifically pointed out in the CS2101 classes.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]