Skip to content

Commit

Permalink
✨ feat: add effort section
Browse files Browse the repository at this point in the history
  • Loading branch information
astraxq committed Apr 10, 2023
1 parent 9afcd4a commit 6f49f5a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,8 @@ The data will be automatically saved by MATHUTORING.

### Difficulty level

This is the first time our team has worked on a Brownfield project where the AB3 codebase was the largest we have encountered in our careers. At the beginning, everyone was overwhelmed by the sudden increase in the number of classes compared to our previous projects, including our most recent project (referred to as "IP"). It took us quite a while to slowly digest the purpose of each class. Additionally, for most of us, this is one of the first projects where we have had to collaborate with team members using version control tools such as Github or SourceTree.

### Challenges faced

We faced several challenges when we were working on this application, the following are some examples and not limited to:
Expand All @@ -916,11 +918,25 @@ we had to take some time to learn from how AB3 works, such as how the user input
specific structures when designing the GUI.
* We also had to spend time searching CSS format in order to tweak the GUI to meet our requirements.
* Thinking how to design the structure of our application based on existing AB3 structure to make it follow Object-oriented programming.
* Making use of a new library to export PDF files.

### Effort required

As a result, the development of this application required a significant amount of effort due to the challenges mentioned above where we have to:

* Debugging and looking up on both Java and JavaFX documentations.
* Researching on the usage of the new library (PDFBox).
* Reading on guides such as tweaking the GUI to fulfil our requirements and an overall better user experience (Drag-and-Drop/CSS).

### Achievements

We were able to produce a complete application that fulfills our user requirements as well as overcame the challenges we have faced. With MATHUTORING, private Math tuition teachers can:

* Manage student contact details and track their performance with task and score records.
* View score charts and statistics to easily evaluate student progress.
* Generate PDF reports containing a student's tasks and scores for easy sharing.
* Export and import data to easily transfer to a new device.

--------------------------------------------------------------------------------------------------------------------

## **Appendix: Planned Enhancements**
Expand Down

0 comments on commit 6f49f5a

Please sign in to comment.