Does Your Manager Come With a README?

Do you know what a README is?

You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.

GitHub’s About READMEs

Pretty good idea isn’t it? Why should we stop there?

When you are looking for a job, you give the potential employer a lot of information about who you are (SSN, education, marital status, background check, credit check, and any information they can glean from the interviews). There is a smaller amount of information coming back the other way, specifically about who your manager is. Normally, you hit the high points in the interview and then “stumble” over their intricacies while on the job. Do you ever wish your manager came with a README?

Now they can! Enter https://managerreadme.com/. I had a manager who included a link to his README in a batch of onboarding documentation. He covered several topics:

  • About Me
  • Team/Culture
  • Time Management
  • Communication
  • 1:1s
  • My Commitments to You
  • My Expectations of You

Did it tell me everything I need to know to work with this person? No, but what a great way to help set expectations for new people on a software development team.

If you think this is a good idea, send your boss a link to https://managerreadme.com/ and tell them create a README to help your future teammates with their on-boarding.

Do you have a README? Share it in the comments.

Leave a Reply

Your email address will not be published. Required fields are marked *