tp

Overview

Kitchen Helper is a desktop application mainly targeted for home user who often have trouble tracking their ingredients in their kitchen. This application allows the user to keep track of their ingredient efficiently, regardless of buying new ingredients at a supermarket or cooking a meal at home. Moreover, the user interaction is mainly through command line interface(CLI), that brings convenience to user who prefers fast typing.

Contribution Summary

• Role: Developer

• Responsibility: Deliverables and deadlines

• Major enhancement:
  • Add Ingredient
    • Functionality: With this enhancement, it allows user to add in ingredients that user already have or newly bought.
    • Justification: This feature improves the product significantly because a user first have to take down the ingredients they have, and using the application makes it convenience to look through the list of ingredients in the application.
    • Highlights: This enhancement prevents expired food to be added to the application, therefore increasing food safety for user consumption.
  • Search Ingredient
    • Functionality: With this enhancement, it allows user to search for ingredients that user already have or newly bought.
    • Justification: This feature allows user to search for something very quickly, instead of looking through a whole list of ingredients.
    • Highlights: User can easily find common or similar ingredients that is available through a simple search.
  • Search Recipe
    • Functionality: With this enhancement, it allows user to search for similar name recipe that user added.
    • Justification: This feature allows user to search for similar recipe name so that they can view and compare the ingredients used.
    • Highlights: User can easily find similar recipes’ name through a simple search.
  • Search Chore
    • Functionality: With this enhancement, it allows user to search for chore that user added.
    • Justification: This feature allows user to search for chore that requires their attention.
    • Highlights: User can easily find unfinished chores through a simple search.
• Minor enhancement:
  • View Help
    • This feature allows user to view all the available commands in Kitchen Helper and also the description of the commands. This feature can be easily be used by typing help in the command line.

• Code contribution: Functional and Test code

• Other contributions:
  • Project management:
    • Ensure that the team members are always aware of weekly deadlines and deliverables.
  • Documentation:
    • Created use cases and updated them into the Developer Guide. (Pull Request: #145)
    • Did the layout for User Guide (Pull Request: #91, #104)
  • Community:
    • Review Pull Request from teammates(with non-trival review comments.) (Pull Request: #131.)
    • Reported bugs for other teams in the class (example: 1, 2, 3)
    • 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 ingredient

• Search for ingredient

• Search for recipe

• Search for chore

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.

• Addition of ingredient

• Search for ingredients based on keyword(s)

• Search for recipe based on keyword(s)

• Search for chore based on keyword(s)

• Part of Use cases in Appendix C

• Instructions for Manual Testing in Appendix F (Example: 1 , 2 , 3 , 4)