Skip to content

Commit

Permalink
Merge pull request #183 from YuSoonZ/update-personal-portfolio
Browse files Browse the repository at this point in the history
Update personal portfolio and acknowledge use of AI
  • Loading branch information
YuSoonZ authored Apr 12, 2024
2 parents e5f5a5f + 85033d8 commit 784395a
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default.md
title: "Developer Guide"
pageNav: 3
layout: default.md
title: "Developer Guide"
pageNav: 3
---

# TA Toolkit Developer Guide
Expand All @@ -13,7 +13,10 @@

## **Acknowledgements**

_{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }_
### Ng Yu Soon's Acknowledgements
* Using ChatGPT to generate documentation for ViewCommand, ViewCommandParser, AddNoteCommand, AddNoteCommandParser, Note and Notes classes.
* Using ChatGPT to generate the format and structure in ViewCommandTest, ViewCommandParserTest, AddNoteCommandTest, AddNoteCommandParserTest, NoteTest and NotesTest classes.
* Using ChatGPT to conform to better structure within Personal Portfolio Page.

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

Expand Down
14 changes: 13 additions & 1 deletion docs/team/yusoonz.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ title: "Yu Soon's Project Portfolio Page"

### Project: TaToolkit Level 3

TaToolkit - Level 3 is a desktop application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
The TaToolkit - Level 3 is a sophisticated desktop application designed to aid in the instruction of Software Engineering principles. It offers a command-line interface (CLI) for efficient task handling and a graphical user interface (GUI) using JavaFX for an enhanced user experience. Comprising approximately 10,000 lines of Java code, it serves as a comprehensive tool for educational facilitators, especially teaching assistants (TAs), to manage student interactions more effectively.

### Technical Skills
* Java Programming: Proficiency in Java to implement complex functionalities.
* JavaFX: Utilization of JavaFX for GUI development.
* Software Engineering Principles: Applied principles like OOP, MVC, and CI/CD during development.

Given below are my contributions to the project.

Expand All @@ -19,6 +24,13 @@ Given below are my contributions to the project.
* Justification: This feature significantly improves the product as it allows TAs to view and retrieve their students' details, such as Telegram, email, or GitHub IDs, should they need to contact them quickly.
* Highlights: This enhancement affects existing commands. It also had to fit into the wider design architecture to ensure it worked with other commands like the `editCommand`.

### Challenges and Problem-Solving
* Integration with Existing Systems: Ensured new features were compatible with existing commands and conformed to the broader system architecture.
* User-Centric Design: Focused on ease of use for the TAs, aligning with the mental model of users to minimize cognitive load.

### Results and Impact
* Improved the mental workload of TAs by streamlining the note-taking process.
* Enhanced the accessibility of student information, leading to quicker and more efficient TA-student communication.

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s2.github.io/tp-dashboard/?search=YuSoonZ&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-02-23)

Expand Down

0 comments on commit 784395a

Please sign in to comment.