PROJECT: 3via

Overview

3via is a desktop application designed for self-learners to overcome their weaknesses and enhance their knowledge at the same time. 3via contains three vital steps in learning path: learning, testing and reviewing. Each step will direct the user into the respective page and the user will interact with it using a CLI, and it has a GUI created with JavaFX.

Summary of contributions

  • Major enhancement: added the ability to undo/redo previous commands

    • What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.

    • Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.

    • Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.

  • Minor enhancement:

    • Added clear command

      • The clear command was morphed from clear command in AddressBook.

  • Code contributed: [Functional code]

  • Other contributions:

Contributions to the User Guide

Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

Clearing all entries : clear

Use with caution! Clears all entries in 3VIA and reboots.

Clear all entries and existing card list(If there exists).
Format: clear

Examples:

  • add q/Why is the earth round? a/Because of gravity t/Physics
    clear
    Card list has been cleared.

  • delete 1
    delete 2
    delete 3
    clear
    No cards to be cleared.

View statistics for a certain test or overall learning path: review [coming in v2.0]

Results of previous tests, questions, expected answers and the user’s answers for that particular topic will be displayed.
A summary of testing results will be displayed in review page.

Format: review TOPIC or review or review HL

Example:

review Physics
Displays the overall statistics of questions attempted of Physics.

review
Displays the overall statistics of all questions attempted.

review HL
Displays card list sorted by high to low times of mistakes

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.

PROJECT: PowerPointLabs

{Optionally, you may include other projects in your portfolio.}

>>>>>>> origin/master