-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update dev guide #35
Conversation
There was a problem hiding this 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.
docs/DeveloperGuide.md
Outdated
*{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 | |
There was a problem hiding this comment.
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
?
docs/DeveloperGuide.md
Outdated
| `* *` | 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 | |
There was a problem hiding this comment.
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.
docs/DeveloperGuide.md
Outdated
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
docs/DeveloperGuide.md
Outdated
| `* * *` | 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 | |
There was a problem hiding this comment.
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?
| `* * *` | 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 | |
docs/DeveloperGuide.md
Outdated
| `*` | 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 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `*` | 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 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.