title

Why simple language isn't so simple: the struggle to create plain language in documentation | I'd Rather Be Writing Blog and API doc course

title

Why simple language isn’t so simple: the struggle to create plain language in documentation | I’d Rather Be Writing Blog and API doc course

charset

utf-8

description

Introduction Writers don’t often realize that their sentences are hard to read Writers don’t want to convert their beautiful prose into short,...

viewport

width=device-width, initial-scale=1.0

og:title

Why simple language isn’t so simple: the struggle to create plain language in documentation

og:locale

en_US

og:description

Although you can adjust your content’s style to be simpler and more readable, technical documentation introduces many new terms and concepts for readers to learn. Many readers who don’t already understand the discourse community may find this language impenetrable. Glossaries and inline tooltips can potentially help novice users, but there’s no easy solution for simplifying your language for both novice and expert users.

og:url

https://idratherbewriting.com/2017/07/27/why-simple-language-isnt-so-simple/

og:site_name

I’d Rather Be Writing Blog and API doc course

twitter:card

summary

twitter:site

@tomjohnson

twitter:creator

@<a href='/aboutme/'>Tom Johnson</a>

canonical

https://idratherbewriting.com/2017/07/27/why-simple-language-isnt-so-simple/

icon

/favicon.ico

stylesheet

https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css

stylesheet

https://cdn.jsdelivr.net/npm/[email protected]/dist/instantsearch.min.css

stylesheet

https://cdn.jsdelivr.net/npm/[email protected]/dist/instantsearch-theme-algolia.min.css