Introduction

What is this?

The CRUK Engineering Guidebook has details on best practices and guides that are used across the tech stack in the organisation.

Why was it created?

This guide was created to help engineers in the organization align technology standards. Before this guide it was difficult to understand what standards should be used across the organisation and many teams had different and competing standards.

This guide hopes to align these such that we have consistency across our technology stacks; reduce the time to learn and switch between teams and reduce time re-inventing the wheel. It will also help lower the burden to first time contributors.

It also provides details and eduction on best practices that products should use. This will ensure that we produce high quality software that meets our standards and is maintainable.

How do I use it?

It is recommended to use the hosted solution found here https://crukorg.github.io/engineering-guidebook/ , but the repository can be checked out locally for offline viewing.

Documents can then be found on the left hand side of the site. It is worth looking through the guidebook in it's entirety on first viewing.

The documents can be used as reference documents after an initial read of the guidebook.

Can I contribute?

We welcome contributions and ideas to this guidebook. Please see our contribution document for details on how to get started.