Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dev guide #35

Merged
merged 4 commits into from
Sep 21, 2020
Merged

Conversation

ruixuantan
Copy link

No description provided.

Copy link

@ypinhsuan ypinhsuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just a few nits to fix.

*{More to be added}*
Priority | As a …​ | I want to... | So that I can... |
| --- | --- | --- | --- |
| `* * *` | Tutor with many students | Store my student's contact info/emails | Contact them easily |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small grammar error. I think it should be students' and not student's?

| `* *` | Careless Tutor | Redo my undone actions | Easily reverse my accidental undos. |
| `*` | Caring tutor | Take note of student's special needs, if any | Cater my teaching toward them |
| `*` | Tutor for many semesters | Archive my past semesters | Avoid cluttering the app |
| `*` | Tutor | Store teaching feedback given by my tutees | Improve my teaching |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it will be nice to change tutees to students? Since we are using students at all other places.

2. Tutor's Pet shows a list of students
3. User requests to edit a specific student in the list
4. User provides the parameters that are to be edited
5. Tutor's Pet edits the student's contact information

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it will be better to remove contact since users can edit tags as well. And tags may not be contact information.

Copy link

@samlsm samlsm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few suggestions. LGTM.

| `* * *` | Tutor with many classes | Create classes | Put my students in the appropriate classes |
| `* * *` | Tutor with many classes | Insert my students into the appropriate classes | Organise my students via classes
| `* * *` | New Tutor | View the help menu | Be familiar with app usage |
| `* * *` | Tutor | Delete student entries | Update my list of students if a student were to drop the module or change tutorial slots |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it be better to remove tutorial slots part cause we don't really have a tutorial?

Suggested change
| `* * *` | Tutor | Delete student entries | Update my list of students if a student were to drop the module or change tutorial slots |
| `* * *` | Tutor | Delete student entries | Update my list of students if a student were to drop the module |

| `*` | Forgetful Tutor | Set an alert for task deadlines | Complete my tasks on time |
| `*` | Forgetful Tutor | Store picture of my students | Easily match their faces to their names |
| `*` | Tutor with many classes | See all tasks related to a class | Easily tell which task belongs to which class |
| `*` | Tutor teaching mods that require many written assignments | View my student's written submissions | Mark/review their homework |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `*` | Tutor teaching mods that require many written assignments | View my student's written submissions | Mark/review their homework |
| `*` | Tutor teaching modules that require many written assignments | View my student's written submissions | Mark/review their homework |

Copy link

@ypinhsuan ypinhsuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ruixuantan ruixuantan merged commit 2b5be4a into AY2021S1-CS2103T-T10-4:master Sep 21, 2020
@junlong4321 junlong4321 added this to the v1.1 milestone Sep 22, 2020
@samlsm samlsm linked an issue Sep 23, 2020 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update DeveloperGuide
4 participants