forked from nus-cs2103-AY2324S2/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
40 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,45 @@ | ||
| [](https://github.com/se-edu/addressbook-level3/actions) | ||
| [](https://codecov.io/gh/AY2324S2-CS2103T-T09-4/tp) | ||
|
|
||
| # TA Helper | ||
| > TA Helper is more than just a tool; it's your ultimate companion in navigating the complexities of teaching assistance in computer science modules. Embrace the simplicity and efficiency of managing your classes with TA Helper today! | ||
| TA Helper is a comprehensive tool designed to significantly ease the administrative and organizational challenges faced by Teaching Assistants (TAs) handling computer science modules. With its core focus on facilitating the management of student groups and enhancing the efficiency of classroom administration, TA Helper stands as an essential platform for TAs who are tasked with overseeing numerous classes and students. | ||
|
|
||
|  | ||
|
|
||
| * This is **a sample project for Software Engineering (SE) students**.<br> | ||
| Example usages: | ||
| * as a starting point of a course project (as opposed to writing everything from scratch) | ||
| * as a case study | ||
| * The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. | ||
| * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big. | ||
| * It comes with a **reasonable level of user and developer documentation**. | ||
| * It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...). | ||
| * For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**. | ||
| * This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info. | ||
| ## User Profile | ||
|
|
||
| - **Target Users:** Teaching Assistants for Computer Science Modules | ||
| - **Key Challenges:** | ||
| - Managing multiple classes and a diverse student body. | ||
| - Forming student teams for projects or assignments while ensuring fairness. | ||
| - Keeping track of student details, progress, grades, and attendance across different modules. | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| Teaching Assistants often grapple with the complexities of generating and assigning students to teams within their classes. The situation is compounded when TAs manage multiple classes, necessitating a streamlined method to oversee various nominal rolls. A unified platform that provides a holistic view of all student information, across every class, is crucial for effective student management. Additionally, the random yet fair formation of student teams for assessments poses a significant challenge. | ||
|
|
||
| ## Value Proposition | ||
|
|
||
| **TA Helper** offers a centralized and user-friendly solution for TAs to manage student information akin to a nominal roll. Its features are tailored to address the specific needs of TAs teaching computer science modules, including but not limited to: | ||
|
|
||
| - **Centralized Student Information:** Store and access contact details and other vital information of students enrolled in the modules you teach, all in one place. | ||
| - **Progress Tracking:** Monitor and record the progress of each student, including grades and attendance, ensuring a comprehensive overview of each individual's academic journey. | ||
| - **Multiple Tabs for Different Modules:** Seamlessly manage different groups of students across various modules you're teaching, with dedicated tabs for each class. | ||
| - **Random Team Generator:** Enhance fairness in assessments by utilizing the optional random team generator, which includes features for adding preferences to accommodate specific grouping needs. | ||
|
|
||
| ## Scope | ||
|
|
||
| The primary scope of **TA Helper** includes: | ||
|
|
||
| - Managing contact details of students for each module taught by a TA. | ||
| - Additional functionalities to track student progress, input grades, and monitor attendance. | ||
| - Optional feature to generate random teams for projects or assignments, considering fairness and preferences. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get started with TA Helper, follow these simple steps: To be updated | ||
|
|
||
| ## References | ||
| This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). |