COMMUNICATION Template


Put an individual COMMUNICATION.md file tailored to the project in each repo. If project repo ownership is transferred to a different team in the future, they need to be able to access and edit documentation related to the project. This includes documentation that outlines the communication processes that users should use to contact the team.

Delete top paragraph when this section is filled out.

Team Communication

Team Slack channel:

Special Slack Channels: (topic specific and accessible to anyone who would be an external contributor)

Team Email:

How to Contact Us

The following types of actions can be moved to the appropriate section and more added.

Action
(General team contact)

Contact Method

(email or slack channel)

Bug report

Feature request

Contribution process questions

Merge Requests after submission

Add more here…

Special Situations:
Direct point of contact (Role)

Status updates

other

other

Add more here...

Roles and Responsibilities

Managers or roles and specific situations they should be contacted for outside the team channel.

(this is set up this way so that the document can easily be changed if there are new members on the team)

Role
Name
Preferred contact method

Outbound Communication

Scenarios
When users will receive communication
Stakeholders who will receive
Action - how to receive these communications

Breaking changes (for e.g. any changes to our API or messaging contracts)

Extended/planned outages (service downtime for maintenance related activities)

Unexpected Outages

Traffic specific changes (e.g. team to team, etc.)

New Feature rollout

As per product guidelines

Month end and company wide code freeze

Internal team and any other teams who contribute to team project repos

Add more…

Documentation Contacts

Tell how to find the owner, responsible party, or group people should contact if they have questions about documentation in the repo.

Describe this communication process.

For example:

  • If you have questions on a specific piece of documentation, you can find the team member responsible for the information by looking here:

  • You can contact the responsible party by sending a message in the xyz channel, send them a direct message in chat, email, etc. The individual who last certified the documentation is the responsible party.


Last updated

Logo

The site is licensed under a CC-BY-SA license unless otherwise marked.