search

RachelChua / pe

0 stars 0 forks source link

Lack of explaination of the purpose of the app #8

Open RachelChua opened 1 year ago

RachelChua commented 1 year ago

image.png

I found it difficult to understand what your app actually does. There was just a vague mention of managing patients but it is unclear how do they do so in managing home visits. Could be better if there was a clearer explanation

nus-se-bot commented 1 year ago

Team's Response

Thank you for submitting this report. Healthcare Xpress is a desktop app for managing patients that require home-visits and nurses. The purpose of the application is to manage patients that requires home-visits and nurses. In the user guide, we have also stated the methods in how the application user can manage them in features. However, if you would like to explicitly see it then we have wrote it in ReadMe.md instead. Alternatively it would be faster to read in the table of contents which is why we have accepted this report.

The 'Original' Bug

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

Error in displaying table of contents in the DG

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.

Currently in the DG, there is a heading for table of contents, but the table of contents is not present below it.

image.png

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

Their Response to the 'Original' Bug

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

Accepted but we believe it should be severity very low as it is purely cosmetic.

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: I disagree that this is a duplicate issue as the original bug shown is that there is a lack of table of content in the developer guide. I was referring to the user guide being unclear on what the app was about in its introduction due to the very brief explanation in the introduction

Firstly, as a user of the app, I would find it troublesome to have to read other resources such as readme, and developer guide to understand what the app is about when I am using the user guide to try out the app.

Secondly, I feel that though you stated that the user guide included the methods in how the application user can manage them in features, it is not very user friendly to have to read through all the methods to understand what the app is about.

I feel that there should a clearer and more in depth explanation at the start of the user guide such that I know what to expect in the features and to know what the app does with a deeper understanding so that I can more easily understand the features as I continue to read the user guide on the features commands.

This is from my point of view as a user and reader of your user guide. While I was testing the app, I find it difficult to understand the features as I did not exactly understand what your app is about at the start.