Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 4.15 KB

SunBangjie.adoc

File metadata and controls

68 lines (48 loc) · 4.15 KB
Raw

Sun Bangjie - Project Portfolio

PROJECT: Part-time Manager (PTMan)

Overview

Part-Time Manager (PTMan) is a desktop human resource application used for managing part-time employees in outlets such as bubble tea shops and fast food restaurants. PTMan aims to give part-time employees the freedom of choosing when they want to work by registering for the available shifts set by the outlet managers. Instead of huge amount of paper work and time spent on communication via phone calls and messages, PTMan helps both managers and employees reduce the hassle of work scheduling.

The user interacts with the application using a Command Line Interface (CLI), and it has a Graphical User Interface (GUI) created with JavaFX. It is written in Java, and has about 10 kLoC.

This project portfolio page aims to showcase my work in the project.

Summary of contributions

  • Major enhancement: Added the outlet feature.

    • What it does:

      • It allows outlet managers to edit outlet information including name, operating hours, contact number and email.

      • It allows managers to create and broadcast announcement to all employees.

      • It allows managers to encrypt and decrypt data stored in local storage files.

    • Justification: This feature improves the product significantly because:

      1. Outlet information is unique and essential. Operating hours will determine the timetable and working schedule. Contact number and email will be used to receive admin password reset. This outlet feature provides convenient ways for managers to manage the outlet.

      2. Creating and broadcasting announcement is necessary as it enhances communication between managers and employees.

      3. Encryption and decryption of local storage files prevents any group of people who do not have the access from interpreting the private and important data, and protects the credential of data.

    • Highlights: This enhancement modifies the existing model to store outlet information. It also modifies the UI component to display outlet information. There were design considerations to integrate outlet information into the existing model while minimizing coupling with the other components. This enhancement also changes the storage component significantly as data stored can be encrypted and decrypted.

  • Minor enhancement: added functionality that backs up local storage files to .backup files.

  • Code contributed: [Functional code] [Test code]

  • Other contributions:

    • Project management:

      • Managed release v1.3 (1 release) on GitHub.

    • Enhancements to existing features:

      • Provided methods to encrypt and decrypt local storage files. (Pull requests: #121, #145, #193)

    • Documentation:

      • Updated user stories, use cases and NFRs in Developer guide: #2, #10

      • Updated formatting of Developer Guide: #23

      • Updated manual testing in Developer Guide: #231

    • Community:

      • Reported bugs and suggestions for other teams in the class (examples: #142)

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.