188体育

Technical writing community

Technical writing helps turn technical concepts into clear, concise and useful information. We write technical documentation and guidance to help technologists use products and services.

The technical writing community exists to:

• help government understand how user-centred technical content can contribute to building and delivering better public services
• define standards and best practice guidelines for technical content
• build capability and skills within the profession

Who the community is for

You do not need to be a technical writer to join. You might be interested in this community if you work in the public sector and you:

• are a technical writer
• are a content designer
• write for technologists
• work with technical writers
• want to know more about technical writing

Training, events, and recruitment

Currently, we鈥檙e not able to offer these due to capacity limitations.

Keep in touch

You can get in touch with us for informal, ad-hoc advice for technical writing challenges. Contact the technical writing community on:

• the - you can create an account using your government email address
• [email protected]

Resources

Articles, courses, training and communities for people who do technical writing, or are interested in learning about technical writing.

What technical writers do and how we work

• Email the technical writing team at [email protected] about attending a group content review (鈥榗rit鈥�), show and tell or weekly meeting

How we write

188体育 style and content principles

• Content design: planning, writing and managing content
• GOV. UK style guide

Writing for technologists

• Documenting APIs and Writing API reference documentation

Writing accessible content

• Examples of and from 188体育 Pay tech docs

Tools and techniques we use

Docs as code

Git and GitHub for writers

Measuring content performance

Writing types of content

GitHub

Error messages

Blogs

Learning about APIs and API design

• has a course on APIs

Learning about technical topics

• Sign up for on Ruby

Communities

Newsletters and mailing lists

Podcasts

Blogs