Skip to content

Commit

Permalink
Merge pull request #259 from Tim-Siu/branch-dg-shuyao-final
Browse files Browse the repository at this point in the history 
Update user stories
  • Loading branch information
@Tim-Siu
Tim-Siu authored Nov 13, 2023
2 parents 33dccb3 + b0d14ba commit 8f430a0
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -653,18 +653,24 @@ a desktop app.

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|---------------------------------------------------|-------------------------------------|----------------------------------------------------------------------|
| `* * *` | CS student at NUS | add companies with openings | keep track of potential internship/job opportunities |
| `* * *` | CS student at NUS | delete company applications | declutter and focus on companies I'm truly interested in |
| `* * *` | CS student at NUS | view all company applications | have a comprehensive overview of my potential opportunities |
| `* * *` | CS student at NUS | add seniors’ contact information | connect for potential collaborative projects |
| `* * *` | CS student at NUS | add professors’ contact information | seek guidance or ask academic-related questions |
| `* * *` | CS student at NUS | add contacts from networking events | have a database for potential job or internship references |
| `* * *` | CS student at NUS | view each contact | access their details swiftly when needed |
| `* * *` | CS student at NUS | delete contacts | keep my contacts list updated and organized |
| `* *` | CS student frequently attending networking events | categorize contacts | easily differentiate between professors, seniors, and other contacts |

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|---------------------------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------|
| `* * *` | CS student at NUS | add person contacts with details | create a comprehensive network of contacts for academic and career purposes |
| `* * *` | CS student at NUS | add company contacts with details | track and manage potential job and internship opportunities |
| `* * *` | CS student at NUS | view all my contacts, including persons and companies | easily access and manage my network and opportunities |
| `* * *` | CS student at NUS | delete person contacts from my list | keep my network current and focused on relevant connections |
| `* * *` | CS student at NUS | delete company contacts from my list | focus on companies and opportunities that are most relevant to me |
| `* * *` | CS student at NUS | edit details of person contacts | update information as my network evolves and changes |
| `* * *` | CS student at NUS | edit details of company contacts | keep track of changes in company details and opportunities |
| `* * *` | CS student at NUS | add internships to company contacts | organize and track my internship applications with specific companies |
| `* * *` | CS student at NUS | delete internships from company contacts | focus on current and relevant internship opportunities |
| `* * *` | CS student at NUS | view details of specific persons or companies | access detailed information quickly for networking or application purposes|
| `* * *` | CS student at NUS | find people or companies using search criteria | locate specific contacts or companies efficiently |
| `* * *` | CS student at NUS | sort companies based on upcoming internship dates | prioritize my preparation and application process |
| `* *` | CS student frequently attending networking events | tag my contacts | easily differentiate between various types of contacts |

These user stories now better reflect the functionalities and processes described in your use cases. They provide a clear and concise description of the system's capabilities from the perspective of a Computer Science student at NUS, focusing on managing contacts, companies, and internship opportunities.

### Use cases:

Expand Down Expand Up @@ -1310,9 +1316,9 @@ trying the following `edit` commands. After `edit i` is run, the company of the
2. Other incorrect find commands to try: `find c`, `find c n/`, `find c t/` without specifying keywords.<br>
**Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. Planned enhancement: To
show a more specific error message.
3. Other incorrect find commands to try: `find c n/has space`, `find c t/has space` that have illegal arguments.<br>
3. Other incorrect find commands to try: `find c n/123numeric`, `find c t/has space` that have illegal arguments.<br>
**Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. Planned enhancement: To
show a more specific error message.
show a more specific error message; To allow numbers and some punctuation symbols in company name keywords.<br><br>
Running the `find c t/transportation` command should result in this output in the Ui:
![DG_find_c.png](images/DG_find_c.png)

Expand Down Expand Up @@ -1454,6 +1460,12 @@ be `Invalid name keyword! Please enter a valid name keyword. The name keyword ca
For tag keyword errors, the message will
read `Invalid tag keyword! Please enter a valid tag keyword. The tag keyword cannot be empty and must be alphanumeric without spaces`.

### Relaxed Constraints for `find c` Commands

Currently, the `find c` command only allows alphabetic keywords for company name keywords. We would like to relax this constraint
to allow alphanumeric characters and some punctuations like & , . - to match the restrictions for company name. This will be a simple
enhancement to the existing code, as we only need to change the regex used to validate the company name keywords.

### Improved Viewing Messages for the display section of the Ui, for `delete c` and `delete p` commands

Currently, for the `delete` commands, if you delete the company/person currently being displayed in the large display box,
Expand Down

0 comments on commit 8f430a0

Please sign in to comment.