Skip to content

Commit

Permalink
Update the implementation of add feature in DeveloperGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xxiaoweii committed Nov 12, 2023
1 parent 0d97f1e commit 375c1e8
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,36 @@ This section describes some noteworthy details on how certain features are imple
### Add Feature
#### Implementation details

The `add` feature allows user to add up to five different details of a person, including the name, role,
contact details, the course he is taking, as well as the respective tutorial classes.
The `add` feature allows user to add up to five different details of a person, including the name, role the person,
contact details, the course the person is taking, as well as the respective tutorial classes.

#### Implementation:

- When adding a profile, the only compulsory field that user has to include is the `name` field.
- All the other fields `role`, `contact` and `course` are optional.
- The fields can be added in any order.
- Users can have more than one input for each of the optional field.
- When adding a `course`, users can also choose to include or not to include the tutorial classes of the course.

#### Design Considerations
<ol>
<li>
<b>User Expectations:</b>
<md>
Users have a common expectation that their favorite persons should be identifiable in the UI. Hence, a role
tag is being added for different roles.
</md>
</li>
<li>
<b>Ease of Use: </b>
<md>
Having only one compulsory field when adding a person makes it faster and easier for users to add someone
into the list, instead of having to type include every single field, some of which might be unknown to the
users.
</md>
</li>
</ol>

### List Feature
#### Implementation details

Expand Down

0 comments on commit 375c1e8

Please sign in to comment.