Writing Inclusive Documentation
Presented by Alanna Burke
Documentation is only useful if people can read it, so it stands to reason that it needs to be accessible. But what about making it inclusive? What does that entail? How can we make sure that everyone is benefitting fully from our documentation AND feeling as though they are the intended audience? Open source projects especially can sometimes make people feel as though they don’t belong - don’t lose your audience because you didn’t think through your writing carefully!
In this session, we’ll discuss how to make sure your documentation can be read and understood by everyone. We’ll talk about strategies to make your writing as clear as possible, which can be difficult when using big technical terms and complex ideas. Have you ever thought about what NOT to say in your documentation - what can be off-putting and make people feel excluded? That’s an important aspect, but one that’s often overlooked, so we’ll go over some things to watch out for. Formatting, layout, and accessibility are also important, so we’ll review some best practices. We’ll also cover some content strategy - making sure your users and readers have access to all of the information they need requires some planning.
At the end of this session, you will come away with an actionable list of items and fixes to apply to your documentation.
https://cmsphilly.org/talks/writing-inclusive-documentation
Видео Writing Inclusive Documentation канала CMS Philly, formerly Drupaldelphia
Documentation is only useful if people can read it, so it stands to reason that it needs to be accessible. But what about making it inclusive? What does that entail? How can we make sure that everyone is benefitting fully from our documentation AND feeling as though they are the intended audience? Open source projects especially can sometimes make people feel as though they don’t belong - don’t lose your audience because you didn’t think through your writing carefully!
In this session, we’ll discuss how to make sure your documentation can be read and understood by everyone. We’ll talk about strategies to make your writing as clear as possible, which can be difficult when using big technical terms and complex ideas. Have you ever thought about what NOT to say in your documentation - what can be off-putting and make people feel excluded? That’s an important aspect, but one that’s often overlooked, so we’ll go over some things to watch out for. Formatting, layout, and accessibility are also important, so we’ll review some best practices. We’ll also cover some content strategy - making sure your users and readers have access to all of the information they need requires some planning.
At the end of this session, you will come away with an actionable list of items and fixes to apply to your documentation.
https://cmsphilly.org/talks/writing-inclusive-documentation
Видео Writing Inclusive Documentation канала CMS Philly, formerly Drupaldelphia
Показать
Комментарии отсутствуют
Информация о видео
2 мая 2020 г. 2:01:03
00:36:03
Другие видео канала
![Techniques for Designing with Drupal 8](https://i.ytimg.com/vi/UTrKUuRWFnc/default.jpg)
![Frontend Performance for Craft CMS Websites](https://i.ytimg.com/vi/jT-cUu-NSow/default.jpg)
![The traffic fallacy](https://i.ytimg.com/vi/gzYLDrOLVtA/default.jpg)
![Becoming an Ally for A11y](https://i.ytimg.com/vi/4x3G5-_8I8o/default.jpg)
![4 Essential Checklists to Manage Drupal Projects](https://i.ytimg.com/vi/EG2N-m2TqW0/default.jpg)
![Can we figure this Drupal Component thing out already?](https://i.ytimg.com/vi/-XMnGvvPVeg/default.jpg)
![Drupal (And Maybe WordPress) Site Content with Airtable](https://i.ytimg.com/vi/SZaQdqarjqc/default.jpg)
![Web Components: The Future of Web Development is Here](https://i.ytimg.com/vi/fLwJCDmbo4E/default.jpg)
![Making Drupal Friendly for Editors and Clients](https://i.ytimg.com/vi/bpO04t75hww/default.jpg)
![Drupal, GraphQL, Views, View Modes and Gatsby for a US Gov site](https://i.ytimg.com/vi/5pzITDUFxkc/default.jpg)
![Introduction to the GraphQL API for WordPress](https://i.ytimg.com/vi/ViSP4ILAEjY/default.jpg)
![Twig in Fractal in Drupal: Decoupling UI Components from Drupal Data Structures](https://i.ytimg.com/vi/Bvfymb0HkHg/default.jpg)
![Rapid Module Development in Drupal 8](https://i.ytimg.com/vi/b1HqN2wJstQ/default.jpg)
![Lucky 7: Don't install ANYTHING 'til you hear this WordPress Plugin Presentation](https://i.ytimg.com/vi/aUk6cFaloYE/default.jpg)
![The Boring Middle Part](https://i.ytimg.com/vi/m30E8fxDq5g/default.jpg)
![Reliable. Fast. Engaging. Progressive Web Applications!](https://i.ytimg.com/vi/4YNMPU_1ILc/default.jpg)
![Optimize SEO with serverless sitemaps](https://i.ytimg.com/vi/6JLSbyE7DGE/default.jpg)
![The hidden power of Layouts in Backdrop CMS](https://i.ytimg.com/vi/1mdtt4WAoys/default.jpg)
![Outgrowing Content Types: Building Custom Entities](https://i.ytimg.com/vi/vIbGDaXAc6c/default.jpg)
![Drupal for Entrepreneurs - let the drop help you do the hard thinking](https://i.ytimg.com/vi/pyG5ECdOqpE/default.jpg)
![Erasing the Stigma: Mental Health in Tech](https://i.ytimg.com/vi/U6vWvqwUYQM/default.jpg)