Team Reports Guide

Welcome! This page explains the reporting templates our team uses to stay aligned and communicate effectively.

Weekly Report

Purpose: Keep the team and leadership informed about your progress, plans, and any help you need.

Who should use it: All developers (frontend, backend, mobile, DevOps, QA, etc.)

When to use it: Every week, typically at the end of your work week (Friday).

What's included:

• Accomplishments and work in progress
• Optional demo video to showcase your work
• Blockers that need attention
• Next week's priorities
• Support or resources you need

Use the Weekly Report Template

Breaking Change Notice

Purpose: Document any API or system changes that will break existing implementations, so other teams can prepare and adapt.

Who should use it: Primarily backend developers making API changes, but also applicable for any developer making breaking changes to shared systems or contracts.

When to use it: Whenever you're planning a change that will:

• Change existing API endpoints (request/response format)
• Remove or rename fields in an API
• Change data types or validation rules
• Modify behavior that other teams depend on
• Require consumers to update their code

What's included:

• What's changing in the API (before/after examples)
• Who will be affected
• Timeline for the change
• Clear explanation of what consumers need to update
• Testing environment and support information

Use the Breaking Change Notice Template

Reporting Schedule