liveBook · Manning

Technical jargon

As explained in Architecting Accessibility

Technical jargon is specialized terminology used within a profession, industry, or technical domain.

Specialized terms can make web-app content harder to understand for non-native speakers, people with cognitive, learning, or language limitations, and even experienced users unfamiliar with a domain. Plain language helps make content more understandable and accessible. section 4.1

Make specialized content easier to understand:

  • Choose simple, concise wording suited to the audience. section 4.1
  • Organize text with paragraphs and subheadings, match the tone to the context, and expand abbreviations on first use. section 4.1
  • Define technical or industry-specific terms. section 4.1
<span style="font-size:16px">Coffee as a service</span>
<br>
We provide an API that affords coffee re-orders with decaying typing
speed. The API typically serves calls within a 2-min mark, but this is
not always guaranteed, especially if there's a surge in API calls. 

This coffee API description uses specialized phrasing; compare it with the clearer messaging-service example. section 4.1

<section aria-labelledby="messaging-service"> #A
  <h2 id="messaging-service">Messaging service</h2> #B
  <p> #C
    We provide an Application Programming Interface #D
    (<abbr title="Application Programming Interface">API</abbr>) #D
    that enables applications to send and receive messages.
  </p>
  <p>
    The API's <dfn id="dfn-latency">latency</dfn> - the time between a #E
    request and message processing - is typically under 200 milliseconds.
  </p>
  <p>
    This <a href="#dfn-latency">latency</a> is not guaranteed, #E
    especially during periods of high traffic.
  </p>
</section>

This messaging-service example expands “API” and defines “latency” in context. section 4.1

How Architecting Accessibility covers it

How deep it goes
Gives practical writing guidance for simplifying wording, structuring content, expanding abbreviations, and defining terms.
Examples
Contrasts a jargon-heavy coffee API description with a messaging-service example that expands API and defines latency.
What you can do after
Apply plain-language techniques by simplifying wording, organizing content, expanding abbreviations, and defining domain-specific terms.
How it connects
Connects technical jargon with plain language, abbreviations, reading level, semantic markup, and accessibility.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Architecting Accessibility. The section links point to the parts of the book it draws on.