search

RuiXiong2211 / pe

0 stars 0 forks source link

Usage of technical jargon in the User Guide #10

Open RuiXiong2211 opened 3 years ago

RuiXiong2211 commented 3 years ago

image.png

Users who are not programmers may not understand technical terms like 'parameters'. Non-technical terms like inputs can be used instead.

nus-pe-bot commented 3 years ago

Team's Response

This is a suggestion, not a bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

I disagree. Even in CS2101, our tutors have mentioned that you should not expect your readers to have any technical knowledge and avoid using technical jargon in your user guide. Few people would understand technical jargons such as 'parameter's unless they have prior programming experience. Your user guide also does not include a glossary which can explain such terms. Thus, this is not a suggestion but a bug as per the PE UG bug guidelines.

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]