Wiki source code of Readability Guidelines
Version 14.5 by Lizzie Bruce on 2019/12/05 09:28
Show last authors
author | version | line-number | content |
---|---|---|---|
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 can 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, devices, channels>>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 | [[Checklist>>doc:.Readability checklist.WebHome]] | ||
30 | ))) | ||
31 | |||
32 | (% class="box" %) | ||
33 | ((( | ||
34 | [[Top findings>>doc:.Top findings.WebHome||style="background-color: rgb(245, 245, 245);"]] | ||
35 | ))) | ||
36 | |||
37 | (% class="box" %) | ||
38 | ((( | ||
39 | [[Our usability questions>>doc:.Usability questions.WebHome]] | ||
40 | ))) | ||
41 | |||
42 | (% class="box" %) | ||
43 | ((( | ||
44 | [[Testing we want to do>>doc:.New research.WebHome]] | ||
45 | ))) | ||
46 | |||
47 | === (% style="color:inherit; font-family:inherit; font-size:26px" %){{id name="Alpha"/}}(%%)Alpha === | ||
48 | |||
49 | We asked if: | ||
50 | |||
51 | ((( | ||
52 | * an open community of content people want to contribute to a single style guide | ||
53 | * we'd like to rely on evidence for the style guide elements – and if yes, what evidence would be most useful | ||
54 | * a wiki model is sustainable | ||
55 | ))) | ||
56 | |||
57 | Read the [[final Alpha blog update>>https://contentdesign.london/research/readability-alpha-the-end/]]. | ||
58 | |||
59 | Alpha ran from July to October, 2018. | ||
60 | |||
61 | |||
62 | === {{id name="Beta"/}}Beta === | ||
63 | |||
64 | From the Alpha discussions we identified 17 content style [[usability questions>>doc:.Usability questions.WebHome]]. We searched for evidence to answer them in Beta. | ||
65 | |||
66 | 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. | ||
67 | |||
68 | Read the [[final Beta blog update>>url:https://contentdesign.london/content-process/readability-guidelines-beta-update-4-by-lizzie-bruce/]]. | ||
69 | |||
70 | Beta was October to December 2018. | ||
71 | |||
72 | |||
73 | (% class="box" %) | ||
74 | ((( | ||
75 | == {{id name="Gi"/}}Get involved == | ||
76 | |||
77 | Explore and join us: | ||
78 | |||
79 | ((( | ||
80 | * read the global Slack discussions: [[readabilityguidelines.slack.com>>url:https://readabilityguidelines.slack.com/]], join: [[bit.ly/2D0OW1F>>url:https://bit.ly/2D0OW1F]] | ||
81 | * read the Content Design London [[project blog posts>>https://contentdesign.london/usability/readability-guidelines/]] | ||
82 | * watch the London Accessibility MeetUp [[Readability Guidelines talk>>url:https://www.youtube.com/watch?v=PQzdtE8JQOs]]' | ||
83 | * share usability studies and academic research evidence on this wiki | ||
84 | * follow #ReadabilityGuidelines on Twitter and LinkedIn | ||
85 | |||
86 | We have almost 500 members in our Slack community. | ||
87 | |||
88 | ))) | ||
89 | |||
90 | == Editing the wiki == | ||
91 | |||
92 | This is a totally open project. You're welcome to comment on, edit or create wiki pages. | ||
93 | The only rules are: | ||
94 | |||
95 | * be respectful | ||
96 | * make any comments in the spirit of positive open learning | ||
97 | * read the wiki pages carefully, and study existing evidence, before making comments and edits | ||
98 | * include usability evidence to support any edits | ||
99 | |||
100 | === Getting a log in === | ||
101 | |||
102 | You can comment on any page without logging in. | ||
103 | 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. | ||
104 | |||
105 | Any comments or queries outside of this wiki, please get in touch on twitter [[@ContentDesignLN>>url:https://readabilityguidelines.slack.com]]. | ||
106 | ))) | ||
107 | |||
108 | == | ||
109 | Wiki sections == | ||
110 | |||
111 | * [[Clear language>>path:/xwiki/bin/view/Plain%20English/]] | ||
112 | * [[Grammar points>>path:/xwiki/bin/view/Punctuation%20and%20abbreviating/]] | ||
113 | * [[Audiences>>path:/xwiki/bin/view/Audience%20descriptors/]] | ||
114 | * [[Content design>>path:/xwiki/bin/view/User%20centred%20design/]] |