/plushcap/analysis/deepgram/technical-writing-accessible-writing-for-developers

Technical Writing: Accessible Writing for Developers

What's this blog post about?

Technical writing aims to be understood by a general audience, including non-native English speakers and beginners in the field. To make technical writing accessible, writers should avoid jargon, acronyms, and numeronyms, and use clear language and structure. Breaking down content into paragraphs with headings and subheadings can also improve accessibility. Giving clear directions, using meaningful link text, and assessing the writing for clarity are essential steps in creating accessible technical content. Resources such as WC3, ASE Simplified Technical English, and Amy Dickens' talk on accessible language provide further guidance on this topic.

Company
Deepgram

Date published
March 28, 2022

Author(s)
Bekah Hawrot Weigel

Word count
929

Hacker News points
None found.

Language
English


By Matt Makai. 2021-2024.