Skip to content

Commit 37b82d9

Browse files
Merge pull request #160 from coding-for-reproducible-research/accessibility-guidance
Guidance for accessible content and education
2 parents 4a78955 + 3e2067f commit 37b82d9

File tree

1 file changed

+64
-2
lines changed

1 file changed

+64
-2
lines changed

contributing/developing_a_course.ipynb

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
},
2323
{
2424
"cell_type": "markdown",
25-
"id": "6afb954b-38f9-4419-92fc-57542f54b8da",
25+
"id": "f33a97e3-4546-4d22-85fe-1098a8eb1f06",
2626
"metadata": {
2727
"editable": true,
2828
"slideshow": {
@@ -41,8 +41,70 @@
4141
"- Assign values to variables and change these values later\n",
4242
"- Perform some simple operations on variables\n",
4343
"\n",
44-
"Your course objectives should be longer-term strategic goals, with the learning objectives being smaller goals that are individually addressed shortly after being presented. \n",
44+
"Your course objectives should be longer-term strategic goals, with the learning objectives being smaller goals that are individually addressed shortly after being presented. "
45+
]
46+
},
47+
{
48+
"cell_type": "markdown",
49+
"id": "9c58868f-f0d1-498d-9f42-7cb2fe5bf45c",
50+
"metadata": {
51+
"editable": true,
52+
"slideshow": {
53+
"slide_type": ""
54+
},
55+
"tags": []
56+
},
57+
"source": [
58+
"## Creating Accessible Content\n",
59+
"\n",
60+
"Ensuring that your content is accessible to all users, including those with disabilities, is a key aspect of creating inclusive educational resources. Below are some guidelines and best practices to help you make your course materials accessible:\n",
61+
"\n",
62+
"### 1. Use Descriptive Headings and Labels\n",
63+
"- **Headings**: Organize your content with proper headings (H1, H2, H3) to ensure a logical structure and easier navigation for screen readers. \n",
64+
"- **Labels**: Use clear, descriptive labels for buttons, links, and forms. Avoid vague labels like \"click here\" or \"read more\", without explicit content describing what the link refers to. \n",
65+
"\n",
66+
"### 2. Provide Alt Text for Images\n",
67+
"- Every image should have an `alt` attribute that describes the content and function of the image. Keep descriptions concise yet informative, especially for complex images like charts and diagrams.\n",
68+
"\n",
69+
"### 3. Ensure Sufficient Color Contrast\n",
70+
"- Use high-contrast color schemes for text and background to make the content readable for users with visual impairments. Tools like the [WebAIM Contrast Checker](https://webaim.org/resources/contrastchecker/) can help you ensure compliance with accessibility standards.\n",
71+
"\n",
72+
"### 4. Avoid Relying on Color Alone\n",
73+
"- Don’t use color as the sole way to convey important information. For example, if you're using color to indicate correct answers, add additional text-based indicators are helpful, such as \"Answer Correct\" or \"Answer Incorrect\".\n",
74+
"\n",
75+
"### 5. Write Clear and Simple Text\n",
76+
"- Write in plain language whenever possible. Avoid complex jargon unless it's absolutely necessary, and provide explanations for technical terms when used.\n",
77+
"\n",
78+
"### 6. Use Accessible Tables\n",
79+
"- When creating tables, include clear headers and captions. Ensure that tables are not used purely for layout purposes, but only for presenting data.\n",
4580
"\n",
81+
"\n",
82+
"### Accessible Web Content Further Reading\n",
83+
"\n",
84+
"The following resouces provide additional material on creating accessible content for the web:\n",
85+
"\n",
86+
"- [Web Content Accessibility Guidelines (WCAG) Overview](https://www.w3.org/WAI/standards-guidelines/wcag/)\n",
87+
"- [Understanding Accessibility Requirements - UK Gov](https://www.gov.uk/guidance/accessibility-requirements-for-public-sector-websites-and-apps)\n",
88+
"\n",
89+
"### Accessible Education Practices Further Reading\n",
90+
"\n",
91+
"For those looking to explore accessible educational practices further, the following resources are helpful:\n",
92+
"\n",
93+
"- [Universal Design for Learning (UDL) Guidelines](https://udlguidelines.cast.org/)\n",
94+
"- [Inclusive Teaching Strategies by the University of Michigan](https://sites.lsa.umich.edu/inclusive-teaching/)\n"
95+
]
96+
},
97+
{
98+
"cell_type": "markdown",
99+
"id": "72ccaad0-e32e-43b3-9382-9246a65443f9",
100+
"metadata": {
101+
"editable": true,
102+
"slideshow": {
103+
"slide_type": ""
104+
},
105+
"tags": []
106+
},
107+
"source": [
46108
"## Ensuring Understanding \n",
47109
"As part of the course, you should aim to ensure that you have some content that a student can use to assess whether they have understood the concept being discussed and outlined in the learning objectives. Two primary methods of doing this are coding exercises and multiple-choice questions. \n",
48110
"\n",

0 commit comments

Comments
 (0)