Yu Jinyang - Project Portfolio Page

PROJECT: The Schwarzenegger

Overview

The Schwarzenegger is a desktop command line interface-based app for managing all your needs regarding fitness. With the built-in personal assistant, you are able to track your daily workout and diet sessions based on your profile. If you can type fast, The Schwarzenegger can help you maximise your efficiency for maintaining fitness.

Summary of Contributions

• Major enhancement:
  • Search Workout Sessions
    • Functionality: This enhancement allows the user to search for specific exercises within the current list of exercises.
    • Justification: This feature improves the product significantly because this allows the user to see at a glance what they want to focus on.
    • Highlights: This enhancement shows the user a targeted list with an easy to read formatting, allowing for quick reading at a glance.
  • Dynamic list formatting
    • Functionality: With this enhancement, it changes the format of the list based on the max length of the name of exercise added.
    • Justification: This feature allows the list shown to the user to look nice and proper even when the name of the exercise is very long.
    • Highlights: This was used in displaying the list for both list and search functions.
  • Handling of different orders of parameters
    • Functionality: With this enhancement, it allows user to use any sequence of entering parameters when adding an exercise.
    • Justification: This feature allows user to enter an exercise with more options of input.
    • Minor enhancement:
      • List Exercises
        • This feature allows user to view all the exercise in the current workout session in a nicely formatted list. This feature can be easily be used by typing list in the command line.
    • Code contribution: Functional and Test code
    • Other contributions:
      • Coherent output format:
        • Ensure that the team members had standardised formatting when showing messages to the user.
      • Documentation:
        • Added Workout Session and logic components into the Developer Guide. (Pull Request: #105)
        • Added Workout Session components for User Guide (Pull Request: #84, #221)
      • Community:
        • Review Developer Guide from other teams in the class(with non-trival review comments.) (Pull Request: #57.)
        • Reported bugs for other teams in the class (example: ped )
        • Perform manual testing, reported bugs and gave suggestions to teammates.

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.

• Adding an Exercise: add
• Listing All Exercises in This Session: list
• Deleting an Exercise: delete
• Searching for Related Exercises: search

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.

• Adding an Exercise
• Deleting an Exercise
• Listing All Exercises in This Session
• Searching for related exercises