tekom-Jahrestagung 2012 - ActiveDoc

Professionelles Schreiben / Technical Authoring
TA 7
Presentation
Writing for Global Audiences
Barbara Jungwirth, reliable translations llc, New York City, USA
English-only documentation is usually aimed at a relatively educated
audience, such as computer programmers, service technicians, and other
technical experts. These professionals do speak English and are familiar
with the English terms used in their specific field. However, English – or
at least U.S. or UK English – is generally not their primary language.
There are two different approaches to handling this linguistic challenge:
−−
Controlled English comprises an approved vocabulary list, as well as
strict rules about the grammar and syntax that can be used.
−−
Global English, by contrast, is a set of guidelines about the type of
vocabulary, grammar and syntax that should be avoided.
Because of its prescriptive nature text in controlled English may sometimes
lose nuances of meaning, while text following the loser global
English guidelines can usually preserve such nuances.
Structuring Your Document
Lists can sometimes better illustrate a set of items than can a descriptive
paragraph. Tables can present the relationship between distinct
pieces of information in a fairly intuitive way. Procedures can sometimes
be summarized in flow charts that require little linguistic knowledge.
Repeating the most important information for each section in
that section’s introduction and summary aids understanding. Shorter
paragraphs are easier to digest. Try to discuss only one concept in each
paragraph.
Vocabulary issues
One of the most important issues is consistency in word choice: same
concept = same term. A corollary to this rule is to use standard terms
with standard spellings and use standard word forms (e.g., assign someone
a task, don’t “task” him or her). Homonyms (words that sound the
same, but mean different things) are difficult to distinguish even for
native speakers, let alone readers with a limited command of English.
Similarly, don’t use acronyms and abbreviations unless absolutely necessary.
If they are indispensable, provide a glossary of terms.
Syntax & grammar questions
Long convoluted sentences with many dependent clauses are difficult
to understand. Complex concepts with many variables can still be expressed
in a series of sentences. Each of these sentences should refer to
the concept explained in the previous sentence by name. Non-specific
pronouns, such as “this” are harder to interpret than if the specific item
to which “this” refers is repeated.
However, do not omit syntactic cues in order to shorten sentences. In
English prepositions such as “that” can often be dropped and the sentence
is still grammatically correct. Leaving such cues in makes it easier
for readers to analyze the relationship between different phrases in a
sentence.
398
tekom-Jahrestagung 2012