Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 7.18 KB

valensia0711.adoc

File metadata and controls

131 lines (99 loc) · 7.18 KB
Raw

Valensia Sebastiani - Project Portfolio

PROJECT: SSENISUB

Ui

Overview

This project portfolio provides detail of my contribution to our group (T13-2) project, SSENISUB, for CS2103.

SSENISUB is a desktop application intended for business organizations to manage information regarding its staff. SSENISUB is CLI-interactive and has a GUI created with JavaFX. It is written in Java and has about 15kLoC.

As a team member, I was in charge of implementing new commands, i.e. favourite/unfavourite and sort/sortDept/sortRatingDown/sortRatingUp. These implemented commands are helpful in increasing the efficiency of the application use by moving favourited staff to the top or the list and sorting the list of staff by the different parameters.

Summary of contributions

  • Code contributed: [RepoSense for valensia0711]

  • Major enhancement 1: added the ability to favourite and unfavourite a staff

    • What it does: Allows the user to favourite a staff (i.e. moves the specified staff to the top of the list) and also allows the user to unfavourite favourited staff (i.e. moves the specified staff back from the top)

    • Justification: The favourite feature makes the use of the application more efficient as some user would always have a few staff with whom they interact or contact frequently. By moving that particular staff to the top of the list, the amount of hassle needed to find and select the staff is omitted. On the other hand, the unfavourite feature is also needed as there are many cases that would lead to no longer frequent interaction with said favourited staff.

    • Highlights: This enhancement also affects the UI other than moving the staff to the top of the list. Favourited staff will be highlighted in yellow and will have a star next to their name.

    • Credits: [Favourite Command by CS2103-2017-T10-B1]

  • Major enhancement 2: added the ability to sort the staff list by different parameters

    • What it does: Allows the user to sort the staff list by three different parameters, i.e. by name, by department, and by rating

    • Justification: Sorting the list by name is significant as it will ease the process of finding a certain staff without having to know their exact name. Sorting the list by department would be really helpful for people at higher positions who are in charge of more than one departments. Sorting the list by rating would be important for managers or HRs as this is the main key needed to review staff performances, and having both options to sort it in ascending or descending order further helps for the different cases possible in an organization setting.

    • Highlights: This enhancement takes into consideration not only the surface sorting but also the minor details, e.g. sort by name command would sort the list by favourite first then sort by name, leaving the favourited staff on top e.g. sort by department command would sort the list by department then by favourite then by name e.g. sort by rating command would sort the list by rating then by favourite then by name

    • Credits: [Guide to Java 8 Comparator.comparing()]

  • Other contributions:

    • Project management:

      • Checked v1.1 - v1.4 (4 releases) before its release

    • Enhancements to existing features:

      • Designed SSENISUB.png used in the UI right side: #42

    • Bug fixes:

      • Fixed bugs in favourite/unfavourite command related to undo/redo command: #100

    • UI changes:

      • Edited person list card UI for favourite/unfavourite command: #76

    • Documentation:

      • Did cosmetic tweaks to existing contents of the User Guide: #123

      • Updated existing contents of the User Guide: #16, #64, #67, #123

      • Did cosmetic tweaks to existing contents of the Developer Guide: #138

      • Updated existing contents of the Developer Guide: #40, #49, #67, #138,

    • Community:

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.

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.