Technical Writer

What you'll do

Technical writers at GDS create user-centred technical content using a ‘docs as code’ approach. Our job is to improve and share technical knowledge, best practice and expertise across government. We work in multi-disciplinary teams to understand user needs and turn them into accurate, accessible technical content.

As a technical writer you’ll:

• write technical documentation for technologists inside government, including API documentation 
• work with technology and process experts to get an in-depth understanding of technical details and system behaviour 
• understand user journeys and information architecture principles so you can structure and present information effectively and sustainably
• develop documentation plans and work with user researchers to understand and help meet user needs
• understand the GOV.UK style and align content appropriately
• work with other technical writers and content designers to make sure documentation is consistent and coherent
• become familiar with existing documentation and improve it through regular iteration
• showcase your work and help promote technical writing as a discipline

Who you are

We’re interested in people who have:

• experience writing technical documentation for digital services and software, including API documentation
• experience in using development tools and workflows to collaborate with developers on documentation
• understanding of Git, GitHub, OpenAPI/Swagger, Markdown, and agile working practices
• understanding of information architecture principles and how to structure documentation to meet user needs
• strong interpersonal skills, specifically in relation to extracting knowledge from technical and process experts
• the ability to work in a fast-paced environment and deliver to deadlines while coordinating work across distributed teams
• the ability to identify and deliver the most appropriate type of content (for example, written or visual) for a particular user need
• the confidence to showcase your work, challenge poor documentation practices, and receive constructive feedback from peers