# Project Plan (David)

**Author**: Team 099

## 1 Introduction
The application is for a single user to compare job offers with different criteria such as benefits and locations. More specifically, it allows a single user to enter job offers and current job details and compare them using customized weights of each consideration factor.

## 2 Process Description

**Activity 1**
- Activity name: Design high-level component diagram and UML diagram
- Activity description: After creating individual UML diagrams, we plan to have a meeting to discuss and review each individual designs and create new high-level component and UML diagrams that we all agree upon
- Entrance criteria: 4 individual UML diagrams, 1-2 zoom meeting, GitHub
- Exit criteria: The output are high-level component diagram and UML diagram that team members all agree upon. We can evaluate them by going through the user requirements and checking whether these two diagrams are able to fulfill all requirements.

**Activity 2**
- Activity name: Design a low-level class diagram
- Activity description: Based on the high-level component diagram and UML diagram designed in activity 1, we would further design a lower level class diagram that represents the static class strcture for each logical/functional component of the system and their relationships. We would provide more implementation details in this low-level class diagram including the inputs and outputs of each methods.
- Entrance criteria: high-level component diagram and UML diagram produced in activity 1, 1-2 zoom meetings, GitHub
- Exit criteria: The output is a low-level class diagram. A satisfactory low-level class diagram should enable all team members to develop the app in Java smoothly without any ambiguity. Moreover, the class diagram should be able to fit in each component of the system so that all user requirements can be fulfilled.

**Activity 3**
- Activity name: Develop the application
- Activity description: Based on the low-level class diagram produced in activity 2, we would distribute the work based on classes designed and discuss via instant messaging if any questions arise. In this activity, the version control technology (i.e. GitHub) plays an important role since we work on the same code base and GitHub helps us to keep track of different versions of the code base and enables us to revert back to previous version if anything goes wrong.
- Entrance criteria: low-level class diagram produced in activity 2, 1-2 zoom meetings, GitHub, IM technology (e.g. WeChat), IDE (i.e. IntelliJ)
- Exit criteria: The output would be a Java code base that implements all classes and functions written in the low-level class diagram and fulfills all user requirements. In this stage, we can evaluate our code base by static checking conducted by the IDE IntelliJ. In next activity, we would do further testing to make sure the app is bug free.

**Activity 4**
- Activity name: Testing
- Activity description: We would test the app through both black-box and white-box methods On the one hand, we would conduct unit test, integration test and even system test leveraging off-the-shelf testing technology such as JUnit and Selenium. On the other hand, we would use and test the app using Andriod app simulator from a user perspective to check whether there are abnormal or unexpected behavior. If there are any bugs found in this step, we may create an issue in GitHub and resolve it in the code base.
- Entrance criteria: Java code base created in activity 3, GitHub, 1-2 zoom meetings, off-the-shelf Java testing tools (e.g. JUnit, Selenium)
- Exit criteria: The output would be some Java test files and modified Java code base. We could evaluate them by some coverage metrics such as code coverage and function coverage and of course we need to make sure all test cases are passed.

## 3 Team

- Team members' names: Jun Chu, Ruiyang Li, Chang Xu, Hengwei Xu
- Roles
- Project manager: Responsible for submitting the commit ID in Canvas on behalf of the entire team and make labor division if needed.
- UI/UX designer: Research and investigate user requirements and designs of similar apps. Design and implement user interface via layout XML file in Android studio.
- Backend engineer: Design the structure of the application and implement backend logics/functions in Java language.
- Test engineer: Design and implement test procedures to ensure that the application works as intended.
- Application security engineer: Explore whether the application has potential security vulnerability and how to mitigate them. Ensure that every step of the software development lifecycle follows security best practices.

| Name | Role |
|------------|----------------------------------------------------------------|
| Jun Chu | Project manager, backend engineer, test engineer |
| Ruiyang Li | Backend engineer, test engineer, application security engineer |
| Hengwei Xu | Backend engineer, test engineer |
| Chang Xu | UI/UX designer, test engineer |