Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 6.27 KB

agnesnatasya.adoc

File metadata and controls

122 lines (89 loc) · 6.27 KB

Agnes Natasya - Project Portfolio

About the Project

HireLah! is targeted to bring greater convenience to interviewers who can type quickly and prefer typing over mouse
commands. Additionally, we included customised features in our desktop apps to help interviewers to manage interviews.

Role

My contribution to the project includes implementing the parser for most of the commands that that was passed as input by the user. I was also involved in building the foundation blocks of an interview report, the transcript. I had also implemented the navigation commands, the commands that are used when the user want to navigate to a certain remark of the interview report of a particular interviewee.

I also contributed to the UserGuide and DeveloperGuide of the application.

Summary of Contributions

It is the placeholder of all information of a particular interview with an interviewee, including the remarks, the attributes and the score associated with it, as well as remarks associated as the answer to a particular question.

  • Major enhancement #1: Implemented the parser for create, update, and delete commands of attributes, interviewees, and questions

    • What it does: allows the user to perform an addition, deletion and edition of attributes, interviewees, and questions of an interview session according to input message to the CLI

    • Justification: These features are a crucial part of the application as it allows the user to add properties to the interview session in order to be able to start the interview.

    • Highlights: This enhancement are totally new and was not part of the codebase. The implementation too was challenging as it required careful considerations on the different possible input received from the user and to handle incorrect and correct input formats properly. I also added unit tests that covers most of the cases in these parser.

  • Major enhancement #2: Implemented open report commands for opening a particular interview report.

    • What it does: allows the user to open the report of a particular interviewee.

    • Justification: These features are useful for the user because it allows them to retrieve the interview report or result after he/she has interviewed a particular interviewee.

    • Highlights: This enhancement are totally new and was not part of the codebase.

  • Major enhancement #3: Implemented navigation commands for navigating in an interview report.

    • What it does: allows the user to perform navigate to a certain remark of an interview report according to time or question number when the user is currently opening the report of a particular interviewee.

    • Justification: These features are useful for the user because it allows them to directly refer to a particular remark that he/she is interested at, instead of scrolling up and down through the whole remarks of an interview report to go to a particular time or answer to a question.

    • Highlights: This enhancement are totally new and was not part of the codebase. The implementation needs careful consideration of the current interviewee, the bounds and input format given by the user.

  • Minor enhancement: added a finalise command for user to indicate if he/she wants to finalise the properties of an interview session and thus can start interviewing.

  • Code contributed: [Collated code]

  • Other contributions:

    • Project management:

      • Created issues for respective milestones from v1.1 to v1.4.

      • Assigned issues to some teammates.

      • Reviewed pull requests from other members of the team (e.g. #121, #96, #81.

    • Enhancements to existing features:

      • Enhanced the codebase and refactor it to suite the need of our application.

      • Removed code from the codebase that are no longer used for the current application.

    • Documentation:

      • Enhanced user guide and developer guide to document things specific to our application (e.g. #110, #119. #122, #136.

      • Removed irrelevant documentation of the codebase.

    • Community:

    • Community:

      • Discovered bug in other teams project and gave suggestions to remove those bugs (e.g. 158, 151)

    • Tools:

      • Our team used TravisCI for building the project (#42)

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.

I have edited the user guide to comply with our application. I wrote parts in user guide specifically for the add, edit and delete commands of attributes, questions and interviewees. I also added guide for the navigation command.

In addition, I also provides screenshots of the result of all commands execution that is included in the user guide to increase understandability and readability by the user.

Add, Edit and Delete Commands for Attributes, Interviewees, and Questions

Open Report Command

Navigation Command

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.

My contributions to the developer guide includes remaking UML diagram for ModelClassDiagram, as well as editing the descriptions and instructions in the developer guide that was customised for the codebase instead of our current application.