search

Financial-Times / engineering-progression

Careers and progression for engineers in the CTO organisation.
https://engineering-progression.ft.com/
MIT License
116 stars 18 forks source link

Add "builds things that are supportable by Operations and Reliability" #300

Open alicebartlett opened 4 years ago

alicebartlett commented 4 years ago

Makes things that are supportable by the Operations team

Junior -> Mid

** We can't actually point to the engineering checklist, but I have emailed O&R to see if any of them have plans to update it, in which case we could add it here.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

rowanmanning commented 4 years ago

Reopening, we probably should have disabled stale bot while we were on hiatus.

rowanmanning commented 3 years ago

OK this seems like a new competency which we should propose for Junior–>Mid. We think a junior should at least have some understanding of how we at the FT make our software reliable and supportable by Operations.

We already have a competency in communication which kind of covers this:

Maintains documentation on the systems they work on, making it easy for future engineers to interact with systems and code, e.g.

  • Writes READMEs with the appropriate level of detail for getting the project set up
  • Documents common issues with the codebase in a troubleshooting section in the README
  • Finds some documentation they are reading is out of date so opens a Pull Request to improve it
  • Writes good commit messages that explain why a change was madePuts line comments around any 'magic' bits of code
  • Writes and updates runbooks for services they work on

However, we think that this should be split into a more technical competency on reliability and operability, and changing this competency to be more around documentation and clearly communicating tech things.

Doing this will involve:

  1. Proposing a change in a PR or in this issue and gathering feedback from the Working Group
  2. Communicating the change more broadly and gathering feedback from other engineers
  3. Releasing the new competency and communicating it