samriddh2145 / pe

0 stars 0 forks source link

Quick start of user guide is not descriptive #7

Open samriddh2145 opened 4 months ago

samriddh2145 commented 4 months ago

Actual - Point 4 of the quick start section in user guide asks the users to "cd into the folder", with no guidance. Many users may not know how to do this.

Screenshot 2024-11-15 at 5.17.51 PM.png

Expected - Add visuals (screenshots) and information (command) for users to follow.

nus-pe-script commented 3 months ago

Team's Response

The User Guide (UG) explicitly states that the target audience consists of university students actively looking for internships in the tech industry​

Screenshot 2024-11-18 at 5.10.33 PM.png

It is reasonable to assume that such users possess basic technical proficiency, including navigating directories in a terminal. If a user lacks this fundamental skill, they are likely not within the intended audience.

The phrase

cd into the folder

is a standard and widely understood command-line operation. Adding visuals or detailed guidance for such a basic command would unnecessarily clutter the UG

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While the intended audience may include university students in tech, it is increasingly common for students from other backgrounds, such as business or design, to seek internships in the tech industry. These users may lack technical proficiency in tasks like navigating directories in a terminal. Including a simple command or a visual guide to "cd into the folder" would make the guide more inclusive and user-friendly. Assuming all users have prior technical knowledge could create unnecessary obstacles for a growing segment of the audience.