search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

[UG] Providing sample text files (assignment answers, assignment student scripts) for users to reference from #189

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

Even though the steps are provided in the UG to generate either an assignment answer or student script, it is tedious to follow and personally I did not have enough time to test the features involved as a result.

Thus, for prospective users, providing some example text files somehow, e.g. generating it from the JAR, or optionally downloading it from a link (even though this might be a bit of a grey area from a course logistics standpoint) may be helpful.

[original: nus-cs2113-AY2021S2/pe-interim#189] [original labels: severity.Low type.DocumentationBug]

jianningzhuang commented 3 years ago

Team's Response

Thank you for your feedback!

However, our UG clearly shows that generating answers or scripts only involves creating text files which are named correctly and adding answers in the correct format. Example screenshots are also shown. From a testing point of view, having a few students with a few questions for the assignment is more than enough to do testing. This is equivalent to a few text files with a few lines each. Hence, we do not believe this is a tedious process, especially since autograding is a big feature.

tedious.PNG

From a user point of view, the answer key will be provided by the professor while the student script is provided by the students. The TA should only edit the text file when there is a format error or change in the answer key. Otherwise, the onus is on the student to format his submission properly.

Duplicate status (if any):

--