Overview
Kitchen Helper is a Command Line Application with the main purpose of keeping track of kitchen inventory and related chores. This application allows the user to manage their kitchen inventory through addition, deletion, viewing and calculating expenditures of ingredients. It also prompts the user by notifications to remind them of expiring or/and low quantities ingredients. The user can then make use of the chore task list feature to remind and keep track of upcoming tasks to perform.
Contribution Summary
-
Responsibility: Testing
- Major enhancement:
- Storage and Load Options
- Functionality: Allows users to not just be able to save and load their data at the start of application but also saving and loading from backup files of their data.
- Justification: This feature improves the product significantly because it serves the primary function of saving and loading user data. This improves convenience as it reduces need for manual inputs.
- Highlights: This enhancement allows a user to go back to an older version of their data by using the backup feature to undo any mistakes made etc.
- Storage and Load Options
- Minor enhancement:
- Save Command
- Functionality: With this enhancement, it allows user to access and update their backup files at any point of their session.
- Justification: This feature allows user to decide exactly when they would like to store the current state of the program.
- Save Command
-
Code contribution: Functional and Test code, Docs and others
- Other contributions:
- Project management:
- Ensures the testing of the project is done properly and on time.
- Enhancement to existing features:
- Documentation:
- Community:
- Project management:
Contributions to the User Guide
Given below are the 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.
- 3.5. Storage Component
- 4.4.1. Select files to load from and save to
- 4.4.2. Save current state
- Appendix F: Instructions for Manual Testing: F.16. Saving data