Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update DG and UG #215

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Update DG and UG #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c86f8c5
Update DG and UG
chuababyy Nov 14, 2023
b1a34d2
Update UG
chuababyy Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -786,7 +787,9 @@ Such associated pairs of use cases are listed in the table below.
<br/>
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.
Expand All @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,6 @@ Here are some descriptions of the words we use throughout the User Guide:

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## Understanding the Graphical User Interface (GUI)

### Quick Orientation
Expand Down Expand Up @@ -1124,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?<br>
**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)

Expand Down
Loading