Skip to content

Commit

Permalink
Merge pull request #36 from moreTriangles/developer-guide
Browse files Browse the repository at this point in the history
Update DeveloperGuide.md
  • Loading branch information
crypto-code authored Sep 29, 2021
2 parents 2516a7e + bd2f329 commit ba342c7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
19 changes: 12 additions & 7 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,13 +275,13 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `* * *` | user | delete contacts | make sure that the address book remains relevant and up to date |
| `* * *` | user | edit individual contacts | update any of the fields when necessary |
| `* * *` | user | add individual contacts | reach out to them later |
| `* * *` | Prof | be able to give my students a way to import in contact details for their peers, TA and profs in the module | - |
| `* * *` | Prof | be able to export a set of contacts | let other professors, TAs and students get a set of contacts quickly |
| `* * *` | new user | be able to import a set of contacts | have some to begin with |
| `* * *` | new user | have an introduction splash screen | utilise the app and its feature well |
| `* * *` | CLI user | avoid using my mouse as much as possible | - |
| `* * *` | user | group/tag people into teammates, classmates, TA's and Profs | easily manage my contacts |
| `* * *` | user | connect with seniors who have taken the same module | have more guidance |
| `* * *` | TA | be able to get in touch with the students in my class through tele handles | - |
| `* * *` | TA | be able to get in touch with the students in my class through Telegram handles | - |
| `* * *` | new user | know all the different commands | fully utilise the tools available |
| `* * *` | new user | learn the command formats | perform tasks quickly and efficiently |
| `* * *` | new user | save contacts | contact these people in the future |
Expand Down Expand Up @@ -423,7 +423,7 @@ MSS

Use case ends.

**Extensions**
Extensions

* 2a. The list is empty.
* Use case ends.
Expand Down Expand Up @@ -451,8 +451,10 @@ MSS
Extensions

* 1a. CohortConnect cannot find the JSON file.
* 1a1. CohortConnect shows an error.
* Use case ends.
* 1a1. CohortConnect shows an error message.
* 1a2. CohortConnect prompts for new filename.
* 1a3. User enters new filename.
* Steps 1a1-1a3 are repeated until the filename received is valid.

* 2a. User decides to cancel the import.
* Use case ends.
Expand All @@ -469,8 +471,10 @@ MSS
Extensions

* 1a. File name already exists.
* 1a1. CohortConnect shows an error.
* Use case ends.
* 1a1. CohortConnect shows an error message.
* 1a2. CohortConnect prompts for new filename.
* 1a3. User enters new filename.
* Steps 1a1-1a3 are repeated until the filename received is valid.

### Non-Functional Requirements

Expand All @@ -486,6 +490,7 @@ Extensions
* **Mainstream OS**: Windows, Linux, Unix, OS-X
* **Private contact detail**: A contact detail that is not meant to be shared with others
* **Main Success Scenario (MSS)**: The most straightforward interaction for a given use case, which assumes that nothing goes wrong.
* **JSON**: JavaScript Object Notation, is a common file format which stores data in key-value pairs and arrays.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/_sass/minima/_base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ table {
text-align: center;
}
.site-header:before {
content: "AB-3";
content: "CohortConnect";
font-size: 32px;
}
}
Expand Down

0 comments on commit ba342c7

Please sign in to comment.