Skip to content

Commit

Permalink
Merge pull request #31 from justinlengch/documentation
Browse files Browse the repository at this point in the history 
Added target user profile, value propositions and rest of the user stories.
  • Loading branch information
@justinlengch
justinlengch authored Mar 18, 2024
2 parents f4fc4d8 + 85044d4 commit 7307e45
Showing 1 changed file with 34 additions and 13 deletions.
47 changes: 34 additions & 13 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pageNav: 3
---

# AB-3 Developer Guide
# TutorTrack Developer Guide

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -274,29 +274,50 @@ _{Explain here how the data archiving feature will be implemented}_

**Target user profile**:

* has a need to manage a significant number of contacts
* has a need to manage a significant number of students
* has a need to quickly manage all their lesson plans
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps
* prefers to view all their students in a centralized platform instead of across separate apps

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
**Value proposition**: TutorTrack revolutionizes private tutoring with intuitive keyboard navigation, integrated
calendar features, and detailed student profiles. </br> Automated reminders keep tutors organized while robust
security measures and responsive support ensure a seamless user experience. </br> Experience efficient student management
with TutorTrack – the ultimate solution for private tutors.


### User stories

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|--|-----------------------------------|------------------------------------------------------------------------|
| `* * *` | new user | view a guide of useful commands | refer to instructions when I forget how to use TutorTrack |
| `* * *` | freelance tutor | add a new student | |
| `* * *` | freelance tutor | delete an existing | remove entries that I no longer need |
| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------|-----------------------------------|----------------------------------------------------------------------|
| `* * *` | new user | view a guide of useful commands | refer to instructions when I forget how to use TutorTrack |
| `* * *` | freelance tutor | add a new student | |
| `* * *` | freelance tutor | delete an existing | remove entries that I no longer need |
| `* * *` | freelance tutor | find a student by name | locate details of persons without having to go through the entire list |
| `* *` | freelance tutor | view all my students' information | view all my students at the same time |
| `*` | freelance tutor | view a specific student's information | specifically refer to a particular student's information |

*{More to be added}*
| `* *` | freelance tutor | view all my students' information | view all my students at the same time |
| `* * *` | freelance tutor | view a specific student's information | specifically refer to a particular student's information |
| `* *` | freelance tutor | edit student information | student information can be edited and changed |
| `* *` | freelance tutor | schedule meeting times with students | I can set lessons |
| `* * *` | freelance tutor | delete meeting times with students | I can cancel lessons |
| `* *` | freelance tutor | edit meeting times with students | I can reschedule lessons |
| `* *` | freelance tutor | view meeting times in a calender view with students | I can track when I have scheduled lessons |
| `*` | freelance tutor | mark attendance for each week | I can keep an accurate record of student attendance and participation over time |
| `*` | freelance tutor | edit milestones on the progress tracker | I can change milestone plans anytime |
| `* *` | freelance tutor | add milestones to a progress tracker | I can keep track of topics covered |
| `*` | student | access a summary page with my progress information | keep track of my progress |
| `*` | freelance tutor | view my schedule in a calendar form | I can keep track of lessons for the week/day |
| `*` | freelance tutor | view a progress tracking meter | I can have a visual representation of a students progress |
| `* *` | new user | create account using email | have an account that stores all the information |
| `* *` | registered user | login to my account | all the information is tracked and stored properly in the account |
| `* *` | freelance tutor | upload files and materials | students can access to them |
| `*` | student | download files and materials | I can review and revise the materials |
| `*` | freelance tutor | send message to students | I can chat with them |
| `*` | student | receive message from tutor | I can be informed with any announcements |
| `*` | student | receive notification from messages | I can be aware of messages send by tutors |
| `*` | freelance tutor | note down basic lesson plans (remarks) for each lesson | I can have a structure to follow for each lesson |

### Use cases

Expand Down

0 comments on commit 7307e45

Please sign in to comment.