search

ondretann / pe

0 stars 0 forks source link

"String" may not be understood by readers #7

Open ondretann opened 6 months ago

ondretann commented 6 months ago

Screenshot 2024-04-19 at 5.15.39 PM.png

Under "Known Issues/Limitations", readers who are not programmers may not understand the term "String". It is better to replace it with "text" or any suitable term understood by the general population.

nus-pe-bot commented 6 months ago

Team's Response

duplicate issue (refer to #1214: some hard to understand information for target users)

The 'Original' Bug

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

Some hard to understand information for target users.

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.

As a NUS student studying in Law, I may not know about what is a string prefix or unsigned integer as seen in the some errors within the application. A more comprehensive glossary may be required as we are catering to a large population of NUS students (not just SoC students)

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

Their Response to the 'Original' Bug

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

This is a fair assessment.

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]