Project Development Plan - TAGCH/Workflow-Automation GitHub Wiki

Project Development Plan

Statement of Work

The project will produce a web application designed to simplify the automation of routine tasks for small teams and individual users that satisfied the requirements specified in Requirements. The application will be developed using react framework

Development Process

Development will use an iterative process. Each iteration has a length of one week starting on Monday and ending on Sunday.

Workflow

Each iteration starts on Monday and ends on Sunday.

  • At the start of each iteration, the Vision, Project Plan, and Requirements are reviewed and updated.
  • A goal for the iteration and at least 1 milestone are defined and written in the Iteration Plan.
  • Major work for the iteration is defined and recorded in the Iteration Plan.
  • The application design is reviewed and revised (if needed) for new features to be added.
  • The Iteration Plan, including the goal, milestone(s), and major work, is added to the wiki.
  • Tasks are defined and written in the Project Backlog on GitHub.
  • A GitHub Task Board for this iteration is created to track work in this iteration.
  • GitHub Flow is used to manage code.
    • For each iteration a new branch is created from main and work is committed to that branch.
    • At the end of the iteration, after the work is tested a Pull Request is opened to initiate a final review.
    • When the work is satisfactory, the branch is merge into main and the Pull Request is closed. Note: GitHub can do both of these in one click.
  • Defects and other issues are recorded in a GitHub Issue Tracker.
    • Note: GitHub can automatically add Tasks to the issue tracker, too.

Meetings

Topic Meeting Time Note
Weekly Meeting Monday Meeting for discussion about project. What will we add, drop? What will we change from original plan?
Emergency Meeting Not Specified In case there are problem that need to be address immediately.
Retrospective Sunday Meeting for discussion on progress of iteration. What went wrong? What can be improve?

Communication

We will communicate through project Discord server. In a case of urgency, Phone call to notify and schedule meeting will be need.

Technology and Tools

  • Coding Language: Python
  • User Interface Library: React
  • Front-End Framework: Bootstrap
  • Development Server: FastAPI
  • IDE: Each team member can choose their preferred IDE (e.g., Visual Studio Code, PyCharm)
  • Communication: Discord for team communication

Milestones

Iteration Milestone
1 Set up project and document
2 User Authentication and Workflow Creation
3 Integrate the Gmail API and enhance the import feature
4 Clear up any remaining work and errors add test.