Merge pull request #362 from gohqingkhang/branch-AddEnhancements

Update for planned enhancements and known bugs

docs/DeveloperGuide.md

@@ -1003,8 +1003,6 @@ testers are expected to do more *exploratory* testing.
    2. Re-launch the app by double-clicking the jar file.<br>
        Expected: The most recent window size and location is retained.
 
-3. _{ more test cases …​ }_
-
 ### Adding a student
 
 1. Adding a student into the list
@@ -1027,8 +1025,6 @@ testers are expected to do more *exploratory* testing.
        `add n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 r/1 s/M c/`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Deleting a student
 
 1. Deleting a student while all students are being shown
@@ -1047,8 +1043,6 @@ testers are expected to do more *exploratory* testing.
       `...` (where x is larger than the list size)<br>
       Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Editing a student
 
 1. Editing a student while all students are being shown
@@ -1068,8 +1062,6 @@ testers are expected to do more *exploratory* testing.
        `edit x c/1A` (where x is larger than the list size)<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding EcName for a student
 
 1. Adding EcName for a student in the list
@@ -1088,9 +1080,7 @@ testers are expected to do more *exploratory* testing.
     5. Other incorrect addEcName commands to try:<br>
        `addEcName`<br>
        `addEcName hhhh en/Jack`<br>
-       Expected: An error message is shown which includes the correct format of the addEcName command to follow. 
-
-2. _{ more test cases …​ }_
+       Expected: An error message is shown which includes the correct format of the addEcName command to follow.
 
 ### Adding EcNumber for a student
 
@@ -1113,8 +1103,6 @@ testers are expected to do more *exploratory* testing.
        `addEcNumber x ep/91234567` (where x is larger than the list size)<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding attendance for a student
 
 1. Adding attendance for a student in the list
@@ -1133,8 +1121,6 @@ testers are expected to do more *exploratory* testing.
        `addAttendance 1 ad/24-09-2024 ar/!@#`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Deleting attendance for a student
 
 1. Deleting attendance for a student in the list
@@ -1153,8 +1139,6 @@ testers are expected to do more *exploratory* testing.
        `addAttendance x ad/24-09-2024 ar/` (where x is larger than the list size)<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding exam for students
 
 1. Adding exam for all students currently in the list
@@ -1171,8 +1155,6 @@ testers are expected to do more *exploratory* testing.
        `addExam ex/#@*`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding exam score for a student
 
 1. Adding exam score for a student in the list
@@ -1191,8 +1173,6 @@ testers are expected to do more *exploratory* testing.
        `addExamScore x ex/Midterm sc/70.0` (where x is larger than the list size)<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Deleting exam for students
 
 1. Deleting exam for all students currently in the list
@@ -1211,8 +1191,6 @@ testers are expected to do more *exploratory* testing.
        `deleteExam ex/#@*`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding submission for students
 
 1. Adding submission for all students currently in the list
@@ -1229,8 +1207,6 @@ testers are expected to do more *exploratory* testing.
        `addSubmission sm/#@*`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Adding submission status for a student
 
 1. Adding submission status for a student in the list
@@ -1249,8 +1225,6 @@ testers are expected to do more *exploratory* testing.
        `addSubmissionStatus x sm/Assignment 1 ss/Y` (where x is larger than the list size)<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Deleting submission for students
 
 1. Deleting submission for all students currently in the list
@@ -1269,8 +1243,6 @@ testers are expected to do more *exploratory* testing.
        `deleteSubmission sm/#@*`<br>
        Expected: Similar to previous.
 
-2. _{ more test cases …​ }_
-
 ### Filtering students
 
 1. Filters all students currently in the list based on the specified attribute and predicate 
@@ -1297,8 +1269,6 @@ testers are expected to do more *exploratory* testing.
        `filter n/ p/`<br>
        Expected: Similar to previous
 
-2. _{ more test cases …​ }_
-
 ### Sorting students
 
 1. Sorts all students currently in the list based on the specified attribute
@@ -1316,15 +1286,48 @@ testers are expected to do more *exploratory* testing.
       `sort 1`<br>
       Expected: Similar to previous
 
-2. _{ more test cases …​ }_
+--------------------------------------------------------------------------------------------------------------------
+
+## **Appendix: Planned Enhancements**
+
+### Ui
+* Ui can be adjusted such that long names and phone numbers will not be truncated when added into StudentManagerPro.
+* For commands with index, a specific error message can be added for missing index instead of the generic invalid command format error message so that users can easily find the error in their command.
+* Instead of just showing an empty data file when a user adds an invalid format to the data file, an error message can be shown when the app is opened.
+* Update help command to show a command summary instead of a link to the UG.
+
+### Sex
+* Sex attribute can be adjusted to be case insensitive in the future to make it more convenient for users.
+
+### Class
+* Class attribute can be made more flexible by allowing different formats for identifying and distinguishing between classes.
+
+### EcName / EcNumber
+* Combine `addEcName` and `addEcNumber` into one command.
+
+### Edit
+* Edit command can be changed such that the student list is not unfiltered after the command is called.
 
-### Saving data
+### Filter
+* Allow filtering by phone numbers using predicates less than 3 digits long.
 
-1. Dealing with missing/corrupted data files
+### Sort
+* Sort in descending order.
+* Sort by more than one attribute at a time (sort by student class, and within each class sort by register number)
+* Edit sort command to use simpler command for faster typing.
 
-   1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_
+### Exam / Submission
+* Exam Score can accept whole numbers and automatically convert them to one decimal point in the future to make it more intuitive for users.
+* Exam Name can accept special characters that may be valid exam names to give users more input flexibility.
+* Submission Status can be adjusted to be case-insensitive in the future to make it more convenient for users.
+* Exam Score and Submission Status can be removed with a blank user input in their respective fields instead of “NIL” for consistency with other features.
+* Include the ability to assign specific exams and submissions to selected groups and not automatically to all students, allowing for customized tests and assignments for different sets of students.
+* Exams and Submissions can be automatically added for new students being added to the list, instead of having the user add them manually.
 
-2. _{ more test cases …​ }_
+### Attendance
+* Adding attendance can be adjusted such that it does not show the entire unfiltered contact list every time it is added.
+* “addAttendance” command can be changed to “trackAbsenteeism” to reduce confusion since the command can delete the records as well.
+* As only dates in the current year are allowed when adding attendance, the command can be adjusted such that it only requires users to enter the date in the form of DD-MM.
 
 --------------------------------------------------------------------------------------------------------------------
 

docs/UserGuide.md

@@ -400,10 +400,6 @@ If your changes to the data file makes its format invalid, StudentManagerPro wil
 Furthermore, certain edits can cause the StudentManagerPro to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
 </box>
 
-### Archiving data files `[coming in v2.0]`
-
-_Details coming soon ..._
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## FAQ
@@ -417,6 +413,8 @@ _Details coming soon ..._
 
 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.
 2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.
+3. **Certain times, the application may lag**, and the student list must be scrolled to update the page.
+4. **User will need to remove the attendances by the end of the year** as students will graduate from the class by the end of the year. Failure to do so will cause the app to crash.
 
 --------------------------------------------------------------------------------------------------------------------