Writing a Report to Client

We aim to provide clients with regular updates on the progress of their projects, ensuring that they are well-informed about the status of their project and milestones. By following these guidelines, developers can maintain transparency, having an effective communication, building trust with the clients, and ultimately maintain a high level of client satisfaction.

How to Create a Report to Client

1. What to Report:
   Developers are required to report on the progress of assigned tasks, updates, and any significant developments since the last report. Please include the link to the PR, or the commit, or the branch.
2. Current Status:
   Indicate the current status of the project, specifying whether it is in the staging or production environment. For example:

   Fixing API error on /chat/message by updating authentication auth middleware to raise error if user not found [PR], Status: Deployed to prod

3. UI Changes:
   If there are UI changes implemented, developers should include screenshots to help the reviewer or the client directly see the changes without running the project locally or opening the changes in another browser tab.
4. Progress Percentage:
   Provide a percentage of completion for the overall project and highlight any completed milestones or tasks.
   For example:

   Implement new chat page design and new flow — The progress of this task is about 35%. Tomorrow, I will continue to finish up the one focus card on the chat page

5. Big Features:
   For big features, developers must outline the remaining tasks and estimate the time required for completion.
   For example:

   The product page on the front end is already finished, however, it’s not connected to the API yet, I will work on this starting from tomorrow, and it will require 2-3 days to complete.