search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Insufficient information about the use of application #2690

Open nus-pe-bot opened 7 months ago

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

Actual: The information at the start only state about "Computing Professors and Teaching Assistants(TAs) to manage your students/professors/TAs' contacts and schedules efficiently, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Our simple-to-grasp software also warmly welcomes professors and TAs from various faculties without any technological background!" but it did not specific what the application will do overall, such as "grouping students into different groups, scheduled is allowed and etc".

Expected: User will expect to understand what the application can provide them before starting to know how to use the app. By jumping straight into the quick start and the different ways of using the command features will confuse the users about what is happening while following the instructions, as they do not have a clear understanding of what the application can truly do for them.

Screenshot:

image.png

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

Ragnapop commented 6 months ago

Team's Response

Our quick start is simply to introduce our app and our target group. While we could introduce some of the feature details here, we decided that it would make the quick start too lengthy and wordy to the casual reader, and hence left it to further paragraph such as the introduction to commands, as we do not want to deter users with a lengthy introduction.

Duplicate status (if any):

--