Skip to content

Commit

Permalink
Merge pull request #379 from JoanneHing/user-guide
Browse files Browse the repository at this point in the history
User guide
  • Loading branch information
JoanneHing authored Nov 12, 2024
2 parents fa3cab1 + bf57ad2 commit 48291af
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
10 changes: 10 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

---

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

**Use case: UC10 - Filter**

**MSS**
Expand Down Expand Up @@ -588,6 +590,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

---

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

**Use case: UC12 - Adding subjects to students**

**MSS**
Expand Down Expand Up @@ -631,6 +635,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
1. Should be able to hold up to 500 students including personal details, contact information, and emergency contacts, without a significant performance drop.
2. All data should be persistent, meaning it must be saved even after the application is closed, ensuring no data loss between sessions.

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

#### Environment Requirements
3. Should work on any _mainstream OS_ as long as it has Java `17` or above installed.
4. 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.
Expand Down Expand Up @@ -658,6 +664,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
#### Accessibility
13. The system should provide keyboard shortcuts and other accessibility features to support users with disabilities.

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

#### Extensibility
14. The system should have a modular design that allows for easy addition of new features and integrations in the future.

Expand Down Expand Up @@ -718,6 +726,8 @@ testers are expected to do more *exploratory* testing.
2. Relaunch the app by double-clicking the JAR file.<br>
Expected: No help window appears. The most recent window size and location are retained.

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

### Adding a student

1. Adding a student with a new NRIC
Expand Down
4 changes: 2 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,8 @@ Examples:

![Filter Success Message](images/filter.png)

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

<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
After filtering, you can use `list` command to return to the full list of students.
</div>
Expand All @@ -560,8 +562,6 @@ will be displayed.
Filtering by year group followed by `tracksubject` allows you to see what subjects are taken by the students in the current year group.
</div>

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

## Subject Management
### Adding subject(s) to a student : `addsubject`

Expand Down

0 comments on commit 48291af

Please sign in to comment.