Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.52 KB

michelleykw.adoc

File metadata and controls

71 lines (50 loc) · 2.52 KB

Michelle Yong Kai Wen: Project Portfolio for EzWatchList

1. Introduction

The purpose of the portfolio is to document my roles and contributions to the project, EzWatchlist in terms of the code, the User Guide and the Developer Guide.

1.1 Overview

In a team of 5 software engineering students, we were tasked to enhance a basic command line interface desktop address book application for our software engineering project. We chose to morph it into a watchlist for movie and television series called EzWatchList.

My role was to design the code for the search feature and ensure proper documentation of the code in general. I had to implement the search feature such that users would be able to search within the watchlist and from online. The code had to be refactored and the search command had to be modified to allow users to search for different categories such as searching by name or actor.

1.2 About EzWatchList

EzWatchList is a desktop application, designed for those who types fast and prefer to work with Command Line Interface (CLI) for managing movies and television series watchlist. It helps users keep track of the shows they had watched or wish to watch, reducing the hassle of having to search for shows frequently.

Ui

Figure 1: The graphical interface for EzWatchlist

[Note]

This symbol indicates information and tips to take note of.

Search

A grey highlight (called a mark-up) indicates that this is a command that can be inputted into the command line and executed by the application.

(different front/colour text)

This indicates that it is a class, method or field in the code.

1.3 Summary of Contributions

This section shows a summary of my coding, documentation, and other helpful contributions to the team project.

Enhancement added:

I modified the search command.

  • What it does: The search command allows the user to search for a show.

  • Justification:

  • Highlights:

  • Credits:

  • Code contributed

Below is a sample of my code:

Please click here to see the above full code and here for other sample of my code.

Other contributions:

  • Project Management:

  • Enhancements to existing features:

  • Documentation:

  • Community:

  • Tools:

1.4 Contributions to the User Guide

1.5 Contributions to the Developer Guide