Wiki source code of Readability Guidelines
Version 12.1 by Cass Bonner on 2019/04/30 09:44
Hide last authors
author | version | line-number | content |
---|---|---|---|
6.66 | 1 | (% class="box" %) | |
8.4 | 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 | ||
6.82 | 4 | ||
5 | (% class="box" %) | ||
6.66 | 6 | ((( | |
6.92 | 7 | **[[Clear language>>doc:Plain English.WebHome]]** | |
6.66 | 8 | ))) | |
9 | |||
6.88 | 10 | (% class="box" %) | |
6.91 | 11 | **[[Grammar points>>doc:Punctuation and abbreviating.WebHome]]** | |
6.88 | 12 | ||
13 | (% class="box" %) | ||
6.94 | 14 | **[[Audiences>>doc:People.WebHome]]** | |
6.88 | 15 | ||
16 | (% class="box" %) | ||
6.91 | 17 | **[[Content design>>doc:User centred design.WebHome]]** | |
6.88 | 18 | ||
6.21 | 19 | == | |
6.86 | 20 | {{id name="#W"/}}The project == | |
6.1 | 21 | ||
10.1 | 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. | |
6.20 | 23 | ||
10.5 | 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"]]. | |
6.65 | 25 | ||
6.61 | 26 | ||
6.87 | 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 | |||
6.34 | 42 | === (% style="color:inherit; font-family:inherit; font-size:26px" %){{id name="Alpha"/}}(%%)Alpha === | |
6.1 | 43 | ||
7.2 | 44 | We asked if: | |
1.1 | 45 | ||
1.12 | 46 | ((( | |
7.2 | 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 | ||
1.2 | 50 | ))) | |
1.1 | 51 | ||
1.26 | 52 | Read the [[final Alpha blog update>>https://contentdesign.london/research/readability-alpha-the-end/]]. | |
1.1 | 53 | ||
1.2 | 54 | Alpha ran from July to October, 2018. | |
1.5 | 55 | ||
1.1 | 56 | ||
6.22 | 57 | === {{id name="Beta"/}}Beta === | |
1.1 | 58 | ||
6.55 | 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. | |
1.1 | 60 | ||
6.98 | 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. | |
6.55 | 62 | ||
1.26 | 63 | Read the [[final Beta blog update>>url:https://contentdesign.london/content-process/readability-guidelines-beta-update-4-by-lizzie-bruce/]]. | |
1.1 | 64 | ||
65 | Beta was October to December 2018. | ||
1.5 | 66 | ||
1.1 | 67 | ||
6.93 | 68 | (% class="box" %) | |
69 | ((( | ||
6.1 | 70 | == {{id name="Gi"/}}Get involved == | |
1.8 | 71 | ||
1.25 | 72 | Explore and join us: | |
1.8 | 73 | ||
1.10 | 74 | ((( | |
6.19 | 75 | * read the global Slack discussions: [[readabilityguidelines.slack.com>>url:https://readabilityguidelines.slack.com/]], join: [[bit.ly/2D0OW1F>>url:https://bit.ly/2D0OW1F]] | |
9.1 | 76 | * read the Content Design London [[project blog posts>>https://contentdesign.london/usability/readability-guidelines/]] | |
1.11 | 77 | * watch the London Accessibility MeetUp [[Readability Guidelines talk>>url:https://www.youtube.com/watch?v=PQzdtE8JQOs]]' | |
1.10 | 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. | ||
6.3 | 82 | ||
1.8 | 83 | ))) | |
84 | |||
6.23 | 85 | == Editing the wiki == | |
1.1 | 86 | ||
12.1 | 87 | This is a totally open project. You're welcome to comment on, edit or create wiki pages. | |
9.2 | 88 | The only rules are: | |
1.2 | 89 | ||
1.16 | 90 | * be respectful | |
91 | * make any comments in the spirit of positive open learning | ||
6.101 | 92 | * read the wiki pages carefully, and study existing evidence, before making comments and edits | |
93 | * include usability evidence to support any edits | ||
1.16 | 94 | ||
9.1 | 95 | === Getting a log in === | |
96 | |||
9.2 | 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. | ||
6.100 | 99 | ||
100 | Any comments or queries outside of this wiki, please get in touch on twitter [[@ContentDesignLN>>url:https://readabilityguidelines.slack.com]]. | ||
6.93 | 101 | ))) | |
6.32 | 102 | ||
6.94 | 103 | == | |
104 | Wiki sections == | ||
6.32 | 105 | ||
6.97 | 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/]] | ||
6.32 | 109 | * [[Content design>>path:/xwiki/bin/view/User%20centred%20design/]] |