Skip to content

Commit

Permalink
Merge pull request #232 from Raghava-Chittidi/branch-rag-fix-docs
Browse files Browse the repository at this point in the history 
Fix bug in docs
  • Loading branch information
@snowstopxt
snowstopxt authored Nov 7, 2024
2 parents 548ab90 + d995d0b commit 6379280
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 52 deletions.
100 changes: 73 additions & 27 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -382,10 +382,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
### Use cases

**System**: HireMe application

**Use Case: UC01 - Add a new internship entry**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to add a new internship entry.
2. HireMe creates a new entry.
Expand All @@ -399,47 +401,56 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.


* 1b. The user does not include the internship role.
* 1b1. HireMe shows an error message.

Use case ends.


* 1c. The user does not include the company email.
* 1c1. HireMe shows an error message.

Use case ends.


* 1d. The user does not include the date of application.
* 1d1. HireMe shows an error message.

Use case ends.


* 1e. The user provided an invalid company name.
* 1e1. HireMe shows an error message.

Use case ends.


* 1f. The user provided an invalid internship role.
* 1f1. HireMe shows an error message.

Use case ends.


* 1g. The user provided an invalid company email.
* 1g1. HireMe shows an error message.

Use case ends.


* 1h. The user provided an invalid date of application.
* 1h1. HireMe shows an error message.

Use case ends.


<br></br>
**System**: HireMe application

**Use Case: UC02 - List all internship entries**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to list all internship entries.
2. HireMe shows all internship entries.
Expand All @@ -453,11 +464,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

<br></br>
**System**: HireMe application

**Use Case: UC03 - Delete an internship entry**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to delete a particular internship entry.
2. HireMe deletes the entry.
Expand All @@ -471,11 +485,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.


<br></br>
**System**: HireMe application

**Use Case: UC04 - Sort all internship applications list**

**Actor**: User
**MSS**

**MSS (Main Success Scenario)**

1. The user requests to sort the internship applications list.
2. HireMe shows all the sorted list of internship applications.
Expand All @@ -490,20 +507,26 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Steps 1a1-1a2 are repeated until the command entered is valid.
Use case resumes from step 2.


* 1b. User enters an invalid order.
* 1b1. HireMe shows an error message that explains how to use the sort command and what parameters are valid.
* 1b2. User enters new command.
Steps 1b1-1b2 are repeated until the command entered is valid.
Use case resumes from step 2.


* 1c. User sorts an empty list.
* 1c1. HireMe shows an empty list.

Use case ends.

Use case ends.

<br></br>
**System**: HireMe application

**Use Case: UC05 - Find internship applications by company name**

**Actor**: User

**MSS (Main Success Scenario)**

1. The user requests to find internship applications by entering a search pattern (e.g., `/find Goo`).
Expand All @@ -519,14 +542,19 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.


* 1b. The provided search pattern matches no company names.
* 1b1. HireMe shows a message indicating that no matching internship applications were found.

Use case ends.

<br></br>
**System**: HireMe application

**Use Case: UC06 - Update the status of an internship application**

**Actor**: User

**MSS (Main Success Scenario)**

1. The user requests to change the status of an internship application by specifying an index and the desired status (e.g., `/accept 2`, `/reject 3`, `/pending 4`).
Expand All @@ -543,13 +571,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

---

<br></br>
**System**: HireMe application
**Use Case: UC05 - Load saved internship applications**

**Use Case: UC07 - Load saved internship applications**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user starts the application.
2. HireMe loads the previously saved internship applications.
Expand All @@ -563,17 +592,20 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.


* 1b. A file with an invalid format is found.
* 1b1. HireMe shows an error message.

Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC06 - Auto-save the current state of the internship list**

**Use Case: UC08 - Auto-save the current state of the internship list**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user performs an action that changes the internship list (e.g., adding, editing, or deleting an entry).
2. The system automatically saves the updated internship list to `hireme.json`.
Expand All @@ -590,12 +622,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC07 - List all internship entries**

**Use Case: UC09 - List all internship entries**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to list all internship entries.
2. HireMe shows all internship entries.
Expand All @@ -610,23 +644,29 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC08 - Summarise all internship entries**

**Use Case: UC10 - Summarise all internship entries**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to view a summary of all internship entries.
2. HireMe shows a summary chart of all internship entries.

Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC09 - Filter internship entries by status**

**Use Case: UC11 - Filter internship entries by status**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user provides a status to filter internship entries.
2. HireMe shows all internship entries with the given status.
Expand All @@ -640,29 +680,35 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC010 - Clear all internship entries**

**Use Case: UC12 - Clear all internship entries**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to clear all internship entries.
2. HireMe clears all internship entries.

Use case ends.


<br></br>
**System**: HireMe application
**Use Case: UC011 - Exit HireMe application**

**Use Case: UC13 - Exit HireMe application**

**Actor**: User

**MSS**
**MSS (Main Success Scenario)**

1. The user requests to exit the application.
2. HireMe application closes and auto-saves the file.

Use case ends.

<br></br>

### Non-Functional Requirements

Expand Down
8 changes: 5 additions & 3 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ HireMe is a **free desktop application that helps you manage your extensive list
* Extraneous parameters for commands that do not take in parameters (such as `/help`, `/list`, `/exit`, `/clear` and `/chart`) are not permitted.<br>
e.g. if the command specifies `/help 123` instead of `/help`, an "Invalid command format!" error message will be shown.

* Command names must be in lower case only.<br>
* Command names must be in **lower case only**.<br>
e.g. `/list` is acceptable but `/List` and `/LIST` are not.

</box>
Expand All @@ -98,8 +98,8 @@ Adds your internship application to HireMe with required details such as company

Format: `/add n/COMPANY_NAME r/ROLE e/EMAIL d/DATE`

* `NAME` must be alphanumeric with the exceptions of `_`,`&`,`/`,`.`,`:`,`(`, and `)`.
* `ROLE` must be alphanumeric except `/`.
* `NAME` must be alphanumeric but these special characters `_`,`&`,`/`,`.`,`:`,`(`, and `)` can also be used.
* `ROLE` must be alphanumeric but these special characters `/` can also be used.
* `EMAIL` must be a valid email address.
* The `DATE` must be within the year 2000 and 2099. It also cannot be a future date which means that the date used must be before today or today's date.
* It must be in the format `dd/mm/yy`, and each field must be double digits (e.g. 01 is valid while 1 is not)
Expand Down Expand Up @@ -245,6 +245,8 @@ Format: `/exit`

HireMe data are saved in the hard disk automatically after any command that changes the data. There is no need for you to save manually.

<br>

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

## FAQ
Expand Down
30 changes: 8 additions & 22 deletions docs/diagrams/ExitSequenceDiagram.puml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,18 @@
!include style.puml
skinparam ArrowFontStyle plain

box UI MODEL_COLOR_T1
participant ":MainWindow" as MainWindow MODEL_COLOR
end box

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant "e:ExitCommand" as ExitCommand LOGIC_COLOR
participant "r:CommandResult" as CommandResult LOGIC_COLOR
end box

[-> MainWindow : executeCommand("/exit")
activate MainWindow
box Model MODEL_COLOR_T1
participant "m:Model" as Model MODEL_COLOR
end box

MainWindow-> LogicManager : execute("/exit")
[-> LogicManager : execute("/exit")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("/exit")
Expand Down Expand Up @@ -45,20 +42,9 @@ deactivate CommandResult
ExitCommand --> LogicManager : r
deactivate ExitCommand

LogicManager --> MainWindow : r
[<--LogicManager : r
deactivate LogicManager

MainWindow -> CommandResult : isExit()
activate CommandResult

CommandResult --> MainWindow : true
deactivate CommandResult

MainWindow -> MainWindow : handleExit()
activate MainWindow

deactivate MainWindow

[<--MainWindow : r
deactivate MainWindow
'Hidden arrow to position the destroy marker below the end of the activation bar.
ExitCommand -[hidden]-> LogicManager
destroy ExitCommand
@enduml

0 comments on commit 6379280

Please sign in to comment.