search

ltzehan / pe

0 stars 0 forks source link

Inappropriate language for UG target audience #5

Open ltzehan opened 1 year ago

ltzehan commented 1 year ago

In the explanation of the list command, the term "ArrayList" is used and may be confusing to the average user that is the target demographic of the UG; consider using simpler terms instead.

image.png

nus-se-script commented 1 year ago

Team's Response

Similar to the other issue, seems to be a typo as I copied paste without checking.

The 'Original' Bug

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

Using Java terms in the 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.

The user, i.e. people working at the veterinary, might not know what "ArrayList" means. Would be better to use "file" instead.

image.png

[original: nus-cs2113-AY2223S2/pe-interim#595] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

No details provided by team.

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]