Project: ForgetfulNUS

ForgetfulNUS is a flashcard application designed to assist students in learning the German Language, specifically those undertaking the NUS modules LAG1201 and LAG2201, as a memory aid for vocabulary.

Responsibilities for the project:

  • Developer
  • Documentation overall-in-charge

Given below are my contributions to the project.

  • New Feature: Ability to sort the glossary according to the parameter input by the user.
    • What it does: allows the user to sort the glossary based on the parameter they input, such as by chronological or alphabetical order for instance.
    • Justification: This allows the user to navigate their glossary much more easily and adds another degree of customisability to the glossary.
    • Highlights: To implement sorting by chronological order, I created a new Order field to be used in every FlashCard, which also required significant refactoring. Also required integration with my teammate’s Difficulty field to implement sorting by difficulty.

  • Code contributed: RepoSense link

  • Project management:
    • Managed releases v1.2, v1.2.1, v1.3, v1.4 (4 releases) on GitHub.
  • Enhancements to existing features:
    • Performed significant refactoring of the original AB3 code at the start of the project to make it suit our product. #90
    • Added an Order field to each FlashCard to facilitate sorting by chronological order. #129
  • Documentation:
    • README:
      • Updated README details at the start of the project. #58
    • User Guide:
      • Ensured that the overall language quality of the User Guide was maintained throughout the project.
      • Improved and maintained formatting for the User Guide throughout the project. (Pull Requests #132 #142 #219).
      • Wrote usage guide for sort feature. #121
      • Updated Command Summary with new features. #\142
      • Updated FAQ and added Help Command. #\142
    • Developer Guide:
      • Added some User Stories and Use Cases. #68 #238 #\240
      • Removed irrelevant information from AddressBook3’s original Developer Guide. #147
      • Added documentation for the sort feature, inclusive of diagrams. #121
      • Updated Appendix - Manual Testing section with more manual tests. #238
      • Improved and maintained formatting for the Developer Guide throughout the project. #238
  • Community:
    • Reviewed Pull Requests from teammates. PRs
    • Reported bugs and suggestions for other teams in the cohort. (examples: 1, 2, 3)
  • Credits:
    • This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.