From c86f8c533871c311f971a4898b9d0458466f7797 Mon Sep 17 00:00:00 2001 From: chuababyy Date: Tue, 14 Nov 2023 10:53:30 +0800 Subject: [PATCH 1/2] Update DG and UG --- docs/DeveloperGuide.md | 14 ++++++-------- docs/UserGuide.md | 2 -- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 815f684e462..97295e79fba 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -536,8 +536,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* *` | user with many internship tasks | find my internship application information based on certain keywords only | find an internship role and view its associated details and tasks without needing to scroll through the whole list of internships | | `*` | user with many internship applications | view overall statistics for my past applications such as at which stage do I get rejected or accepted | understand which stage I need to improve on and which stage I'm stronger in | +-------------------------------------------------------------------------------------------------------------------- -### Use cases +## **Appendix C: Use cases** For all use cases below, we assume the following unless specified otherwise @@ -786,7 +787,9 @@ Such associated pairs of use cases are listed in the table below.
Use case resumes from step 2. -### Non-Functional Requirements +-------------------------------------------------------------------------------------------------------------------- + +## **Appendix D: Non-Functional Requirements** 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. 2. Should be able to hold up to 500 assignments or internship details without a noticeable sluggishness in performance for typical usage. @@ -797,14 +800,9 @@ should be able to accomplish most of the tasks faster using commands than using 6. The software should work without requiring an installer. 7. The GUI should work well for standard resolutions. -### Glossary - -* **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Private contact detail**: A contact detail that is not meant to be shared with others - -------------------------------------------------------------------------------------------------------------------- -## **Appendix: Instructions for manual testing** +## **Appendix E: Instructions for manual testing** Given below are instructions to test the app manually. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3f1a987614a..1cf89d8f3b8 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -128,8 +128,6 @@ Here are some descriptions of the words we use throughout the User Guide: -------------------------------------------------------------------------------------------------------------------- -
- ## Understanding the Graphical User Interface (GUI) ### Quick Orientation From b1a34d2cfc9a203fd694948916f942470f29ab0a Mon Sep 17 00:00:00 2001 From: chuababyy Date: Tue, 14 Nov 2023 10:59:12 +0800 Subject: [PATCH 2/2] Update UG --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1cf89d8f3b8..6a3adbc1868 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1122,7 +1122,7 @@ For Mac Users you may wish to follow the instructions listed [here](https://nus- ### Transferring data to another computer **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 Campus Companion home folder. +**A**: Install the app in the other computer. With Campus Companion closed on your new computer, overwrite the newly created campuscompanion.json with the campuscompanion.json from your previous computer. After that, when you relaunch the application, you should see the new data. [Scroll back to Table of Contents](#table-of-contents)