This portfolio is meant to be a well-documented data point of my Software Engineering experience on the project. It showcases my contributions to the project and my documentation skills.
StudyBuddyPro is a desktop Command Line Interface (CLI) application intended for Computing School students of National University of Singapore (NUS). It aims to lessen target users' revision time consumption without compromising the quality of studies with a centralized platform.
StudyBuddyPro provides three main features: Flashcard, Notes and Cheatsheet. These features are used to revise using flashcards, take notes and generate cheatsheets respectively. Additionally, StudyBuddyPro is equipped with a Graphic User Interface (GUI).
The above image shows how StudyBuddyPro looks like with the descriptions of each functional areas and icons.
Please do take a look at the syntax notations below as they are used throughout the document.
syntax 1 — For commands or class objects
syntax 2 — For figures, tables, functionality or variables
Please do refer to the signs below as they are used throughout the document.
|
Warning
|
Indicates information that are to be adhere as potential problems may be encountered if you are not careful. |
|
Important
|
Indicates information that are crucial to understand so that you will be able to follow the flow of the document. |
|
Note
|
Indicates information that are note-worthy. Do read them for more information and better understandings. |
The sections below are a summary of my contributions to the project. It highlights my major contributions and states my minor, code and other contributions.
This enhancement allows users to automatically generate cheatsheets according to the tags that they specify. From this, it improves the product significantly as users can sift out information to be included in a specific cheatsheet. Thus, it reduces the users' time taken in collating cheatsheets.
This enhancement’s implementation makes use of the other features in the StudyBuddyPro to create the contents in the cheatsheets. As such, users can make full use of this auto-generation enhancement by using tagging functionality in those features.
This enhancement allows users to remove contents in the generated cheatsheets by specifying its content indexes or tags. From this, it improves the cheatsheets' usability as users can determine which contents to be included or excluded in the cheatsheets.
This enhancement ensures all contents are placed under the tags specified even after users' personalization. Hence, users can be assured that the cheatsheets contain no irrelevant contents.
This enhancement allows users to toggle amongst the features in the StudyBuddyPro. Also, it allows global commands, like exit or filterall to be used in any features.
This enhancement allows users to clear specific feature’s data in the StudyBuddyPro. As such, users do not need to clear the entire data if desired.
The sections below are my contributions to the UG of StudyBuddyPro. They showcase my ability to write documentation that targets the end-users.
|
Important
|
All commands in the sections assume that the user is in the cheatsheet mode. |
The sections below are my contributions to the DG of StudyBuddyPro. They showcase my ability to write technical documentation. Also, it portrays my technical depth of my contributions to StudyBuddyPro.