Branch update ug #240

AaronJT1 · 2023-11-11T16:25:59Z

Summary of change

Update user guide for parts allocated and update PPP to hit page count

Key changes

User Guide

added the allocated portion, add/view feature, faq and quick start

PPP

reduced the PPP headings to hit page count

Currently, the user guide is outdated and does not have a proper faq section It is important to update the faq section accordingly as the product grow Update the faq section of user guide

Currently, my PPP when converted to pdf exceeds 2 pages It is important to stick within the page limit Update the PPP to reduce page count

RiyaMehta2211

Good job with the changes made in the UG and the PPP! Left a few suggestions on modifications to be made in the UG but other than that LGTM!

RiyaMehta2211 · 2023-11-11T16:57:50Z

docs/UserGuide.md

    3. If you have Java installed, you should see your Java version as shown underlined in the picture below.
       <img src='images/javaversion.png' width='500'>
    4. If you do not have Java or your Java version is below 11, install Java
       11 [here](https://www.oracle.com/java/technologies/downloads/#java11)


-2. Go to your Desktop and create a folder named “A&E”.
+2. Go to your Desktop and create a folder named “AAndE”.


Thank you for standardizing the format of the name of the folder and all throughout!

RiyaMehta2211 · 2023-11-11T16:58:19Z

docs/UserGuide.md

+application.
+
+**Q**: I have a list of patients, how do i view their details?\
+**A**: Please click on the patient you are interested in viewing. The details will be on the right hand side in the


I think you can use similar phrasing as lines 231-232 as the point is the same for consistency. Though this is just a minor suggestion and not really an issue

RiyaMehta2211 · 2023-11-11T16:58:31Z

docs/UserGuide.md

+**A**: Please click on the patient you are interested in viewing. The details will be on the right hand side in the
+Patient Record Panel.
+
+**Q**: The Patient List Panel is cut off, i cant see some details for each patient\


I think for the qn here, the "i" can be capitalized and can't should have a ', just for consistency in the user guide haha

RiyaMehta2211 · 2023-11-11T16:58:46Z

docs/UserGuide.md

+
+**Q**: The Patient List Panel is cut off, i cant see some details for each patient\
+**A**: Please resize the application by dragging the border of the application window with your mouse.
+If the appplication is already in full screen mode, please drag the divider between the Patient List Panel and Patient


A typo for application in line 433, but other than that, the phrasing is good!

RiyaMehta2211 · 2023-11-11T16:58:55Z

docs/UserGuide.md

+If the appplication is already in full screen mode, please drag the divider between the Patient List Panel and Patient
+Record Panel to the right.
+
+**Q**: I entered a command and there is no response from the application, what do i do?\


Similar suggestion on the capitalization of I, other than that, good job on the FAQs!

thienmy0

Looks good overall but do take a look at the comments! Thanks for updating the UG 👍

thienmy0 · 2023-11-11T16:58:05Z

docs/UserGuide.md

+**Caution:** Duplicate patients are not allowed. Duplicate patients refer to patients with the same name and/or IC
+number.


We planned to have these in boxes rather than just bolding the Caution/Note/Tip right?

According to https://markbind.org/userGuide/components/presentation.html I think the code would be something like the following?

<box type="info"> info </box> <box type="warning"> warning </box> <box type="tip"> tip </box>

ok will take note of that!

thienmy0 · 2023-11-11T17:02:56Z

docs/UserGuide.md

+number.
+
+- Names are case-sensitive
+    - Han Bo is different from han bo


Perhaps "Han Bo" and "han bo" should be Han Bo and han bo instead, such that it is more in line with our Google Doc UG? same for IC number below

thienmy0 · 2023-11-11T17:04:51Z

docs/UserGuide.md

+**A**: Yes, A&E saved your data after every command executed.
+
+**Q**: How do I transfer my data to another Computer?\
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains


Perhaps we could be clearer on this "data file" part in case users do not understand what it is and how to overwrite it?

thienmy0 · 2023-11-11T17:06:20Z

docs/UserGuide.md

+**A**: Yes, A&E has the [Undo](#undoing-a-command--undo) feature which allows you to retrieve all the lost details.
+
+**Q**: Will my data be saved immediately?\
+**A**: Yes, A&E saved your data after every command executed.


Perhaps there is a grammatical error here and it should be "saves" rather than "saved"?

thienmy0 · 2023-11-11T17:07:16Z

docs/UserGuide.md

+the technical team in charge of your department to file a bug report on our [issues](tps://github.com/AY2324S1-CS2103T-T14-2/tp/issues) page.
+
+**Q**: I have accidentally cleared the whole patient record system, can i retrieve the lost details?\
+**A**: Yes, A&E has the [Undo](#undoing-a-command--undo) feature which allows you to retrieve all the lost details.


I think the link to undo might be wrong as it should be one dash(-) instead of two

thienmy0 · 2023-11-11T17:08:31Z

docs/UserGuide.md

-Q: How do I transfer my data to another Computer?
-A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the
-data of your previous A&E home folder.
+**Q**: I double-clicked the Jar file and it doesnt run, why?\


Perhaps you are missing an apostrophe for "doesn't"?

thienmy0 · 2023-11-11T17:11:22Z

docs/UserGuide.md

+**Q**: How do I transfer my data to another Computer?\
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains
+the data of your previous AAndE home folder.
+



Perhaps you are missing a link back to the Table of Contents after FAQs?

Currently there are some typo and mistakes in the UG. It is important to fix this typo constantly Update UG to take into account comments

AaronJT1 added 2 commits November 11, 2023 23:47

Update user guide to add faq section

641c11a

Currently, the user guide is outdated and does not have a proper faq section It is important to update the faq section accordingly as the product grow Update the faq section of user guide

Update PPP page

a148e54

Currently, my PPP when converted to pdf exceeds 2 pages It is important to stick within the page limit Update the PPP to reduce page count

AaronJT1 added the priority.High Must do label Nov 11, 2023

AaronJT1 added this to the v1.4 milestone Nov 11, 2023

AaronJT1 self-assigned this Nov 11, 2023

RiyaMehta2211 reviewed Nov 11, 2023

View reviewed changes

thienmy0 requested changes Nov 11, 2023

View reviewed changes

AaronJT1 and others added 2 commits November 12, 2023 12:38

Update UG to take into account comments given

7b27abb

Currently there are some typo and mistakes in the UG. It is important to fix this typo constantly Update UG to take into account comments

Merge branch 'master' into branch-update-ug

072bb49

RiyaMehta2211 merged commit 32fe2fd into AY2324S1-CS2103T-T14-2:master Nov 12, 2023
0 of 3 checks passed

thienmy0 mentioned this pull request Nov 12, 2023

[PE-D][Tester E] UG Quick Start Command Does Not Work on Mac #184

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Branch update ug #240

Branch update ug #240

AaronJT1 commented Nov 11, 2023

RiyaMehta2211 left a comment •

edited

Loading

RiyaMehta2211 Nov 11, 2023

RiyaMehta2211 Nov 11, 2023

RiyaMehta2211 Nov 11, 2023

RiyaMehta2211 Nov 11, 2023

RiyaMehta2211 Nov 11, 2023

thienmy0 left a comment

thienmy0 Nov 11, 2023

wujy28 Nov 11, 2023

thienmy0 Nov 12, 2023

AaronJT1 Nov 12, 2023

thienmy0 Nov 11, 2023

thienmy0 Nov 11, 2023

thienmy0 Nov 11, 2023

AaronJT1 Nov 12, 2023

thienmy0 Nov 11, 2023

thienmy0 Nov 11, 2023

thienmy0 Nov 11, 2023

		Caution: Duplicate patients are not allowed. Duplicate patients refer to patients with the same name and/or IC
		number.

Branch update ug #240

Branch update ug #240

Conversation

AaronJT1 commented Nov 11, 2023

Summary of change

Update user guide for parts allocated and update PPP to hit page count

Key changes

User Guide

PPP

RiyaMehta2211 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thienmy0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RiyaMehta2211 left a comment •

edited

Loading