Ng Shu Lin Jane - Project Portfolio Page

Project: KAJI

Overview

KAJI is a desktop command line interface application catered for university students to schedule their revision, as well as allow them to revise content in the form of flashcards. It is written in java.

Summary of Contributions

Given below are my contributions to the project:

• New Feature: Added the ability to add flashcards.
  • What it does: Allows the user to add flashcards to a chapter.
  • Justification: This feature improves the product significantly because a user can revise the chapters in the form of flashcards and it makes revision much easier for the user.
• New Feature: Added the ability to list all the flashcards.
  • What it does: Allows the user to list all the flashcards in a chapter.
  • Justification: This feature improves the product significantly because a user can view the entire content of a chapter.
• New Feature: Added the ability to edit modules/chapters/flashcards.
  • What it does: Allows the user to edit the name of a module and chapter and content of a flashcard.
  • Justification: This feature improves the product significantly because a user can make mistakes when adding a module/chapter/flashcard and the application provides a convenient way to rectify them.
• New Feature: Added the ability to reschedule a chapter.
  • What it does: Allows the user to reschedule the due date of a chapter.
  • Justification: This feature improves the product significantly because a user can change the schedule according to their situation.

• Code Contributed: RepoSense link

• Project Management:
  • Managed releases v1.0 - v2.1 (3 releases) on GitHub
  • Maintaining the issue tracker
• Documentation:
  • User Guide:
    • Added documentation for the features Editing a chapter name, Rescheduling a chapter, Adding a flashcard, Listing flashcards available and Editing a flashcard content
  • Developer Guide:
    • Added implementation details for the features Edit Module Name, Edit Chapter Name, Add Flashcard, Edit Flashcard Content and Reschedule Chapter
    • Added class and sequence diagrams for Logic Component, Edit Module Name, Edit Chapter Name, Add Flashcard, Edit Flashcard Content and Reschedule Chapter
    • Added user stories
    • Added non-functional requirements
    • Added instructions for manual testing for #5.6.1., #5.6.2., #5.6.3., #5.6.4., #5.6.5., #5.6.6., #5.6.7., #5.6.8., #5.6.9.
• Community:
  • PRs reviewed (with non-trivial review comments): #19, #20, #27, #55, #62, #63, #76, #81, #85, #222
  • Reported bugs and suggestions for other teams in the class (examples: #1, #2, #3, #4, #5, #6, #7, #8, #9)