Wiki source code of Readability Guidelines

Version 12.1 by Cass Bonner on 2019/04/30 09:44
Show last authors
1 (% class="box" %)
2 A project from [[Content Design London>>http://contentdesign.London]].
3 \\"Imagine a collaboratively developed, universal content style guide, based on usability evidence. With guidelines for creating easy to comprehend content, we'll design inclusively by default." – Sarah Richards
4
5 (% class="box" %)
6 (((
7 **[[Clear language>>doc:Plain English.WebHome]]**
8 )))
9
10 (% class="box" %)
11 **[[Grammar points>>doc:Punctuation and abbreviating.WebHome]]**
12
13 (% class="box" %)
14 **[[Audiences>>doc:People.WebHome]]**
15
16 (% class="box" %)
17 **[[Content design>>doc:User centred design.WebHome]]**
18
19 ==
20 {{id name="#W"/}}The project ==
21
22 In 2018 Sarah Richards asked if, working together, we can create a [[universal, inclusive style guide>>url:https://contentdesign.london/blog/usability/readability-guidelines]]. Because "style guide" can mean different things, we called it the Readability Guidelines project.
23
24 Content professionals in multiple sectors held regular global discussions for a total of 24 weeks. This was [[Alpha>>||anchor="Alpha"]] and [[Beta>>||anchor="Beta"]]. And it's all continuing: you can [[get involved>>||anchor="Gi"]].
25
26
27 (% class="box" %)
28 (((
29 [[Top findings>>doc:.Top findings.WebHome]]
30 )))
31
32 (% class="box" %)
33 (((
34 [[Our usability questions>>doc:.Usability questions.WebHome]]
35 )))
36
37 (% class="box" %)
38 (((
39 [[Testing we want to do>>doc:.New research.WebHome]]
40 )))
41
42 === (% style="color:inherit; font-family:inherit; font-size:26px" %){{id name="Alpha"/}}(%%)Alpha ===
43
44 We asked if:
45
46 (((
47 * an open community of content people want to contribute to a single style guide
48 * we'd like to rely on evidence for the style guide elements – and if yes, what evidence would be most useful
49 * a wiki model is sustainable
50 )))
51
52 Read the [[final Alpha blog update>>https://contentdesign.london/research/readability-alpha-the-end/]].
53
54 Alpha ran from July to October, 2018.
55
56
57 === {{id name="Beta"/}}Beta ===
58
59 From the Alpha discussions we identified 17 content style [[usability questions>>doc:.Usability questions.WebHome]]. We searched for evidence to answer them in Beta.
60
61 By the end we created the first readability guidelines, identified [[top level findings>>doc:Main.Top findings.WebHome]] and accepted that some style points needed further testing.
62
63 Read the [[final Beta blog update>>url:https://contentdesign.london/content-process/readability-guidelines-beta-update-4-by-lizzie-bruce/]].
64
65 Beta was October to December 2018.
66
67
68 (% class="box" %)
69 (((
70 == {{id name="Gi"/}}Get involved ==
71
72 Explore and join us:
73
74 (((
75 * read the global Slack discussions: [[readabilityguidelines.slack.com>>url:https://readabilityguidelines.slack.com/]], join: [[bit.ly/2D0OW1F>>url:https://bit.ly/2D0OW1F]]
76 * read the Content Design London [[project blog posts>>https://contentdesign.london/usability/readability-guidelines/]]
77 * watch the London Accessibility MeetUp [[Readability Guidelines talk>>url:https://www.youtube.com/watch?v=PQzdtE8JQOs]]'
78 * share usability studies and academic research evidence on this wiki
79 * follow #ReadabilityGuidelines on Twitter and LinkedIn
80
81 We have almost 500 members in our Slack community.
82
83 )))
84
85 == Editing the wiki ==
86
87 This is a totally open project. You're welcome to comment on, edit or create wiki pages.
88 The only rules are:
89
90 * be respectful
91 * make any comments in the spirit of positive open learning
92 * read the wiki pages carefully, and study existing evidence, before making comments and edits
93 * include usability evidence to support any edits
94
95 === Getting a log in ===
96
97 You can comment on any page without logging in.
98 But if you'd like to add usability evidence please [[request a log-in>>mailto:lizzie@contentdesign.london]]. It may take a few days for us to set up your wiki account.
99
100 Any comments or queries outside of this wiki, please get in touch on twitter [[@ContentDesignLN>>url:https://readabilityguidelines.slack.com]].
101 )))
102
103 ==
104 Wiki sections ==
105
106 * [[Clear language>>path:/xwiki/bin/view/Plain%20English/]]
107 * [[Grammar points>>path:/xwiki/bin/view/Punctuation%20and%20abbreviating/]]
108 * [[Audiences>>path:/xwiki/bin/view/Audience%20descriptors/]] 
109 * [[Content design>>path:/xwiki/bin/view/User%20centred%20design/]]