angkoonhwee / pe

0 stars 0 forks source link

[UG] Link leads to stackoverflow discussion #9

Open angkoonhwee opened 2 years ago

angkoonhwee commented 2 years ago

Section 3.3 Upload Data

upload link to stackoverflow.png

The link here leads to a discussion on stackoverflow.

Expected: Clear step by step explanation in UG on how to download the sample upload file.

Actual: Discussion on a public forum with multiple answers and discussions. Very messy.

nus-pe-bot commented 2 years ago

Team's Response

This sample CSV file mentioned is meant to be optional in case the testers do not want to spend too time simulating how a user would create a CSV file of students. Our team feels that it is reasonable to expect our target users (CS2100 Lab TAs) and testers (mostly CS students) to know how to download CSV files from GitHub, and the link provided at “here” is provided just in case in an attempt to be helpful. Moreover, both target users and testers should be reasonably familiar with Stackoverflow to be able to find the solution (any of the first few answers would work).

Alternatively, our team could have copy-pasted the solution into our UG, but we feel this in fact makes the UG messy with unnecessary information that the majority of target users is unlikely to require. Severity changed to very low as we do not feel the hyperlink here hinders users (rather, its omission would have resulted in a few users being unsure how to download a file from GitHub).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The main point of raising this as a bug is that the stackoverflow link serves no point except to confuse users. Suppose your assumptions are true, then there is no need for the "here" link to stackoverflow. And suppose that your assumptions are false and that it is not just CS students familiar with github using the app, then clicking onto this link would be of no help with the array of answers that might just confuse the user even more. And would it be so hard to link a webpage with the exact steps instead of a forum with multiple replies?

Furthermore, I feel like there is too many implicit assumptions here. While it is reasonable to expect SoC students how to download CSV files from github, there is still a possibility that some CEG students that have not taken software engineering students comprising a portion of CS2100 TAs. Also, CS2100 is a Computer Architecture module, that is not particularly heavy on software so it is likely that one might not know how to maneuver github.


:question: Issue severity

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

Reason for disagreement: The main point of raising this as a bug is that the stackoverflow link serves no point except to confuse users. The link here is redundant at best and confusing at worst. Which is not just a cosmetic issue/typo as it might cause minor inconveniences for users in situations where they are not equipped with using github. This is not a cosmetic issue as it might confuse potential users with the lack of clear instructions.