From b776d3f1f4be67a9486381c2687d262ce17c2fb5 Mon Sep 17 00:00:00 2001 From: linnn-7 Date: Wed, 6 Mar 2024 21:29:49 +0800 Subject: [PATCH] Update DG --- docs/DeveloperGuide.md | 28 ++++++++++++++++++++++------ docs/UserGuide.md | 32 ++++++++++++++++++++++++++++++-- 2 files changed, 52 insertions(+), 8 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 63cec155dc8..c8e6dbc3e29 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -268,7 +268,7 @@ _{Explain here how the data archiving feature will be implemented}_ * prefers typing to mouse interactions * is reasonably comfortable using CLI apps -**Value proposition**: manage contacts faster than a typical mouse/GUI driven app +**Value proposition**: manage employee information more efficiently and clearly than a typical mouse/GUI driven app ### User stories @@ -288,7 +288,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) +(For all use cases below, the **System** is the `PayBack` and the **Actor** is the `user`, unless specified otherwise) **Use case: Delete a person** @@ -313,15 +313,31 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case resumes at step 2. -*{More to be added}* +**Use case: Edit an employee** + +**MSS** + +1. User requests to edit an employee's information +2. User enters the employee's ID and fields that need to be updated +3. PayBack changes the employee's information accordingly + + Use case ends. + +**Extensions** + +* 2a. The ID is invalid. + * 2a1. PayBack shows an error message. + + Use case ends. + ### 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 1000 persons without a noticeable sluggishness in performance for typical usage. +2. Should be able to hold up to 1000 employees without a noticeable sluggishness in performance for typical usage. 3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. - -*{More to be added}* +4. The system should provide real-time access to employee information with response times not exceeding 2 seconds for any query. +5. The app should have an intuitive user interface, allowing users to easily navigate and perform tasks without extensive training. ### Glossary diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5239c231135..48a2a19e018 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -149,11 +149,11 @@ Examples: ### Saving the data -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +PayBack data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. ### Editing the data file -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/payback.json`. Advanced users are welcome to update data directly by editing that data file. +PayBack data are saved automatically as a JSON file `[JAR file location]/data/payback.json`. Advanced users are welcome to update data directly by editing that data file.
:exclamation: **Caution:** If modifications to the data file result in an invalid format, PayBack will discard all data and initiate the next run with an empty data file. @@ -161,6 +161,34 @@ Therefore, it is advisable to create a backup of the file before making any edit Additionally, specific changes may lead to unexpected behavior in PayBack, such as if a value entered falls outside the acceptable range. Hence, proceed with editing the data file only if you are certain that you can make accurate updates.
+### Archiving data files `[coming in v2.0]` + + +_Details coming soon ..._ + + +-------------------------------------------------------------------------------------------------------------------- + + +## Q&A + + +**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 PayBack home folder. + + +-------------------------------------------------------------------------------------------------------------------- + + +## Known issues + + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. + + +-------------------------------------------------------------------------------------------------------------------- + + ## Command summary Action | Format, Examples