Skip to main content

Technical Documentation Template

What you can use this template for

This is a template for technical and developer documentation (“tech docs”).

It uses the Middleman static site generator to convert Markdown files into HTML-based documentation that looks consistent with GOV.UK style and format.

It is suitable for multiple styles of documentation, including API documentation.

Why you should use this template

It promotes consistency on technical documentation which should reassure end users.

It helps technical writers manage their technical content using the ‘docs as code’ approach.

Who should use this template

The Tech Docs Template is for internal use by the GDS and government community.

This page was last reviewed on 1 July 2020. It needs to be reviewed again on 1 July 2021 by the page owner #tech-writers .
This page was set to be reviewed before 1 July 2021 by the page owner #tech-writers. This might mean the content is out of date.