READMEs
Creating and publishing your Bramble README
As part of Bramble’s transparency value, we encourage each Bramble team member to consider adding a README — a great tool for transparently letting others know what it’s like to work with you, and how you prefer to be communicated with.
Purpose of READMEs
When people are working together for the first time, there’s a certain amount of mental and emotional energy exerted in getting to know someone. You’re simultaneously doing the work, while trying to confirm or challenge preconceived notions about how a person prefers to be communicated with.
On an individual level, this requires a person to project the ideal version of themselves into each meeting, as it is assumed that this projection is the only meaningful way for another person to understand who they are and how they prefer to communicate and work.
READMEs provide a genuine report on how a person works, reducing bias/assumption and enabling people to work together based on a common framework.
Bramble team README examples
Bramble division README pages are linked below for context. Let these serve as a guide and inspiration as you create your own.
How to create a Bramble README
- Copy the README-template and paste into your favorite Markdown editor. If you do not have a Markdown editor, Sublime, Typora and Bear are recommended.
- Fill out the recommended sections. Note that each section is optional. You can remove those you aren’t comfortable filling out, and add sections that are germane to you.
- Once complete, you’ll need to create a new page and a subsequent merge request to add the page to Bramble’s website.
- If your division already has a page to host READMEs (see above), follow the guidelines to add a new page within that directory (e.g. Glenn R., head of engineering, would add a new directory and page within
/handbook/engineering/readmes, creating/handbook/engineering/readmes/glennr) - If your division does not yet have a holding page for READMEs, follow the guidelines to add a new page (
readmes) within your division’s handbook section first, then create your username directory withinreadmes.
- If your division already has a page to host READMEs (see above), follow the guidelines to add a new page within that directory (e.g. Glenn R., head of engineering, would add a new directory and page within
Making your README visible
Once your README is created, consider adding a link to it in the following places.
- Google Doc agendas or calendar invites
- Your GitLab.com profile
- Slack profile
- Email signature
This provides maximum visibility to others, so that they may ingest your README in advance of working with you. This allows them to take your working style and communication preferences into account, ideally increasing the overall level of empathy expressed.
READMEs are particularly powerful when working with those outside of Bramble, who may be unfamiliar with our values. A README is a beacon of transparency, and helps set the tone for any working relationship.