Skip to content

Commit

Permalink
Update UserGuide and DeveloperGuide for Load data and Purge data
Browse files Browse the repository at this point in the history
  • Loading branch information
ooawagaeri committed Sep 26, 2021
1 parent f3aaa98 commit c638d51
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 21 deletions.
95 changes: 75 additions & 20 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ layout: page
title: Developer Guide
---

* Table of Contents
{:toc}
* Table of Contents
{:toc}

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

Expand Down Expand Up @@ -309,12 +309,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

**MSS**

1. User requests to send an email
2. MyCRM shows a list of jobs
3. User requests to email a specific job in the list
4. MyCRM shows a list of email templates
5. User requests to copy a specific email template
6. MyCRM generates the email of the job and template
1. User requests to send an email.
2. MyCRM shows a list of jobs.
3. User requests to email a specific job in the list.
4. MyCRM shows a list of email templates.
5. User requests to copy a specific email template.
6. MyCRM generates mailto link of the job and template

Use case ends.

Expand Down Expand Up @@ -344,20 +344,20 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

**MSS**

1. User requests to add an email template with specific subject and body
2. MyCRM creates email template
1. User requests to add an email template with specific subject and body.
2. MyCRM creates email template.

Use case ends.

**Extensions**

* 1a. The given subject is empty
* 1a. The given subject is empty.

* 1a1. MyCRM shows an error message.

Use case resumes at step 1.

* 1b. The given body is empty
* 1b. The given body is empty.

* 1b1. MyCRM shows an error message.

Expand All @@ -367,19 +367,19 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

**MSS**

1. User requests to view all email template
2. MyCRM shows a list of email template
1. User requests to view all email template.
2. MyCRM shows a list of email template.

Use case ends.

**Use case: UC13 - Deleting an email template**

**MSS**

1. User requests to delete an email template
2. MyCRM shows a list of email template
3. User requests to delete a specific template in the list
4. MyCRM shows deletes the template
1. User requests to delete an email template.
2. MyCRM shows a list of email template.
3. User requests to delete a specific template in the list.
4. MyCRM shows deletes the template.

Use case ends.

Expand All @@ -395,6 +395,58 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes at step 2.

**Use case: UC14 - Viewing user guide**

**MSS**

1. User requests to view the user guide.
2. MyCRM shows a popup with the GitHub user guide URL.

Use case ends.

**Use case: UC15 - Exiting the program**

**MSS**

1. User requests to exit MyCRM.
2. MyCRM shows a goodbye message.

Use case ends.

**Use case: UC16 - Loading from JSON file**

**MSS**

1. User request to load data from a specific JSON file.
2. MyCRM loads data from JSON file data into job, contact, product list.

Use case ends.

**Extensions**

* 1a. The JSON file does not exist.

* 1a1. MyCRM shows an error message.

Use case ends.

* 1b. The JSON file's content fails to parse.

* 1b1. MyCRM shows an error message.

Use case ends.

**Use case: UC17 - Purging MyCRM data**

**Precondition:** Data in MyCRM (job, contact and product list) is not empty.

**MSS**

1. User request to purge data.
2. MyCRM removes data from job, contact, product list.

Use case ends.

### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
Expand All @@ -413,9 +465,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Glossary

* **Mainstream OS**: Windows, Linux, Unix, OS-X
* **Private contact detail**: A contact detail that is not meant to be shared with others
* **Mainstream OS**: Windows, Linux, Unix, OS-X.
* **Private contact detail**: A contact detail that is not meant to be shared with others.
* **Repair Job**: A customer request to restore machinery, equipment, or other products to working order.
* **JSON**: Javascript Standard Object Notation, which is a form of syntax used for storing data.
* **mailto**: A Uniform Resource Identifier scheme for email addresses, produces hyperlinks on websites that allow
users to send an email.

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

Expand Down
16 changes: 15 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ been optimised for use via a Command Line Interface (CLI)** while maintaining th
applications.

* Table of Contents
{:toc}
{:toc}

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

Expand Down Expand Up @@ -144,12 +144,26 @@ Examples:

### Retrieve previous command

### Viewing user guide: `help`

Shows a message explaining how to access the help page.

Format: `help`

### Exiting the program : `exit`

End MyCRM and exit the programme.

Format: `exit`

### Loading JSON data: `[coming in v1.3]`

_Details coming soon ..._

### Purging JSON data: `[coming in v1.3]`

_Details coming soon ..._

### Pinning Jobs `[coming in v1.3]`

_Details coming soon ..._
Expand Down

0 comments on commit c638d51

Please sign in to comment.