search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

The term XYZ is used throughout the developer guide, but there are better alternatives #3191

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.

The term XYZ is used throughout the developer guide, but there are better alternatives, such as resource.

XYZ gives a unprofessional look.

[original: nus-cs2103-AY2223S2/pe-interim#2544] [original labels: severity.Low type.DocumentationBug]

BoAi01 commented 1 year ago

Team's Response

If we are inconsistent, i.e., use resource and XYZ interchangeably, testers may raise the issue that this is confusing.

Why do we prefer XYZ over resource then? This is because these words mostly appear in code segments or UML diagrams as a name holder, and resource is too long a word. Resource is also not too accurate when describing objects like 'locations' or 'flights', which makes them unsuitable for this purpose.

From this issue, we can tell that XYZ is accurate in its meaning, which is good enough for the developer guide, given that the readers have a technical background.

Duplicate status (if any):

--