Architecture
How to design a Defra service and the systems it depends on.
This guidance builds on the GOV.UK Service Standard and the technology section of the GOV.UK Service Manual. The Technology Code of Practice sets out the criteria government uses to design, build and buy technology.
You should also read the Defra outcome delivery group model.
If you work in a software development role, see software development.
Follow this guidance when you are:
- building a GOV.UK digital service
- building an internal digital service at Defra
This guidance may not apply if you are:
- deploying commercial off-the-shelf software
- building a data or reporting platform
Getting started
To get started, you should:
- Contact the Delivery Architecture team
- they'll help you architect your service and explain governance requirements
- they'll let you know the principal architect for your delivery group
- Review the Defra software development standards
- these are mandatory and the Delivery Architecture team handles any exceptions through their governance process
- Work with the Delivery Architecture team to decide if the Core Delivery Platform (CDP) is right for your service. This is Defra's strategic platform for building and deploying services.
You will need to read the following documentation if your service adopts the Core Delivery Platform:
- onboarding considerations to understand what the platform offers
- architectural overview to learn how the platform is built
- how-to documentation
To access the Core Delivery Platform, you will need to be on a Defra device or VPN.
Recommended approach
To deliver a service that meets users needs faster and at a lower cost, follow these guidelines:
- build on the Core Delivery Platform
- use Defra's common tools as part of your service
- use Defra's approved technologies and languages
- code in the open from the start, storing code in the Defra GitHub organisation
- analyse code in the Defra SonarQube Cloud organisation
- follow Defra's README standards
- maintain solution overview documentation, architecture decision records and architecture diagrams
Approved technologies and languages
Defra restricts the languages and frameworks teams can use. The current list, the reasons behind each choice and how to request a new technology are in approved technologies and languages.
Common tools
| Tool | Description |
|---|---|
| Core Delivery Platform | Defra's internal development platform for building, deploying and running services |
| Defra Customer Identity | External authentication and authorisation |
| Defra Forms | Accessible forms that follow GOV.UK standards |
| Defra Interactive Map | Accessible frontend mapping component |
Get support
If you need help designing your service, contact the Delivery Architecture team.