Wiki source code of Specialist terms

Version 3.2 by Lizzie Bruce on 2019/04/23 14:30
Show last authors
1 (% class="box" %)
2 (((
3 (% class="wikigeneratedid" %)
4 Following this helps:
5
6 * **people in a hurry** – simply written content is easier to scan and absorb instantly
7 * **people who are stressed** – if you're anxious you find it harder to comprehend things
8 * **people who are multi-tasking** – if you're holding a baby or running a business your attention's divided
9 * **cognitive impairments** – easy to understand words and sentences carry less cognitive load
10 * **visual impairments** – short and simple sentences convey meaning in a smaller visual field
11 )))
12
13
14 == Guidelines ==
15
16 Make specialist content comprehensible by non-experts.
17
18
19 (% class="wikigeneratedid" id="H1.Explainspecialistterms:A0anybodycanaccessyourcontent." %)
20 [[1. Explain specialist terms: anybody can access your content.>>doc:||anchor="#1"]]
21
22 (% class="wikigeneratedid" id="H2.Createcontentthatalluserscanunderstand2Cwhatevertheirexpertiseorbackground." %)
23 [[2. Create content that all users can understand, whatever their expertise or background.>>doc:||anchor="#2"]]
24
25 (% class="wikigeneratedid" id="H3.Helpusersunderstandspecialistterms." %)
26 [[3. Help users understand specialist terms.>>doc:||anchor="#3"]]
27
28 (% class="wikigeneratedid" %)
29 [[Usability evidence>>doc:||anchor="#UEST"]]
30
31
32 ----
33
34 === {{id name="#1"/}}1. Explain specialist terms: anybody can access your content. ===
35
36 Assuming who your audience is, and that they'll understand the technical terms you use, are common misconceptions.
37
38
39 === {{id name="#2"/}}2. Create content that all users can understand, whatever their expertise or background. ===
40
41 When you present a concept explain its parts and processes in detail.
42
43 If you need to include a technical term consider explaining it. Make sure the surrounding language is in plain language.
44
45
46 === {{id name="#3"/}}3. Help users understand specialist terms. ===
47
48 You could:
49
50 * link to an existing definition – this could be an external site
51 * add a explanatory definition after using the term
52
53
54 Example:
55
56 **Before**
57 "It is a Palladian style stone building, and contains a number of splendid paintings and much fine wood-carving." – [[original sentence>>url:http://sentence.yourdictionary.com/palladian]]
58 \\**After**
59 (% class="mark" %)"It is a [[Palladian style>>url:http://www.vam.ac.uk/content/articles/s/style-guide-palladianism/]] stone building, and contains a number of splendid paintings and much fine wood-carving."(%%) – with link to a definition
60 \\(% class="mark" %)"It is a Palladian style stone building and contains a number of splendid paintings and much fine wood-carving. Palladian style architecture features include columns, symmetry and decorative arches."(%%) – with explanatory definition
61
62 ----
63
64 == {{id name="#UEST"/}}Usability evidence: specialist terms ==
65
66 [['Writing Digital Copy for Domain Experts'>>url:https://www.nngroup.com/articles/writing-domain-experts/]], Nielson Norman Group, 2017
67
68 [['Writing Digital Copy for Specialists vs. General Audiences'>>url:https://www.nngroup.com/videos/writing-digital-copy-specialists/?lm=how-users-read-on-the-web&pt=article]], Nielson Norman Group, undated
69
70 [['Plain Language For Everyone, Even Experts'>>url:https://www.nngroup.com/videos/plain-language-for-experts/?lm=how-users-read-on-the-web&pt=article]] Nielson Norman Group, undated
71
72 [['TechWhirl Fast 5: Understanding Plain Language and Simplified Technical English'>>url:https://techwhirl.com/techwhirl-fast-5-understanding-plain-language-simplified-technical-english/]], Connie Giordano, TechWhirl, 2017
73
74 [['Advantages and disadvantages with Simplified Technical English'>>url:https://liu.diva-portal.org/smash/get/diva2:16816/FULLTEXT01]], MSc thesis paper, Karin Disborg, 2007
75
76 [['Technical Writing Need Not Be Abstruse—Use Plain Language for Maximum Impact'>>url:https://digital.gov/2015/10/23/technical-writing-need-not-be-abstruse-use-plain-language-for-maximum-impact/#]], Colleen Blessing, 2015
77
78 [['The Facets of the General Public as Audience'>>url:https://www.dropbox.com/s/2u2cybl7c57u0tr/AudienceIssues.pdf?dl=0]] Cheryl Stephens and Mariah Stufflebeam, 2017
79
80 [[‘Guidelines for authoring comprehensible web pages and evaluating their success’>>http://faculty.washington.edu/jan sp/Publications/Authoring_Comp rehensible_Web_Pages.pdf]], Spyridakis, J. H., Technical Communication, 2000, pp. 359– 82
81
82 ----
83
84 (% class="box" %)
85 (((
86 (% class="wikigeneratedid" %)
87 See also:
88
89 * [[Plain English>>doc:Plain English.Plain English, simple sentences.WebHome]]
90 * [[Simple sentences>>url:https://readabilityguidelines.myxwiki.org/xwiki/bin/view/Plain%20English/Simple%20sentences/]]
91 * [[Law, medicine, money>>url:https://readabilityguidelines.myxwiki.org/xwiki/bin/view/Plain%20English/Medical/]]
92 * [[Words to avoid>>url:https://readabilityguidelines.myxwiki.org/xwiki/bin/view/Plain%20English/Words%20to%20avoid/]]
93 )))