SlideShare a Scribd company logo
1 of 10
Download to read offline
How to write
inclusive tech documentation
Lucie Le Naour
Agenda
• What is inclusive documentation?
• Why should documentation be inclusive?
• Some best practices
• Q&A (or debate?)
How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
Inclusivity
Inclusive documentation is a documentation that takes into
account all of its users, regardless of their gender, culture,
abilities, etc.
How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
What is inclusive
documentation?
„The quality of trying to include many different types
of people and treat them all fairly and equally.“ - Cambridge
Dictionary
Inclusive documentation
Because you are writing for your user!
How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
Why should documentation
be inclusive?
This Photo by Unknown Author is licensed under CC BY-SA
Rubber stamp template: www.presentationmagazine.com
This Photo by Unknown Author is licensed under CC BY-SA
THE USERYOU
How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
Some best practices
Educate yourself…
… by exchanging with the people in your life
This Photo by Unknown Author is licensed under CC BY-SA-NC
How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
Some best practices
Educate yourself…
… by paying attention to the news
This Photo by Unknown Author is licensed under CC BY-NC
How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019
Some best practices
Use language as a tool!
• Language shapes the way humans think: listen cognitive
scientist Lera Boroditsky talk about it here.
• The words you choose matter: latest studies show for example
that the use of gender-neutral pronouns boosts positive
feelings towards women and LGBT people, read about it here
and here.
• The words you choose definitely matter: AI using language
corpora has been shown to reproduce human biases, read
about it here and here.
How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019
Some best practices
Use language as a tool!
© Lucie Le Naour
How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019
Some best practices
Use design as a tool!
• Design your documentation for guidance: use multiple formats
and place the information where different users need it,
Microsoft explains it better here.
• Steal from your UI/UX colleagues: start using inclusive visuals
in your docs, read about it here.
How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019
Q&A
Shoot!

More Related Content

Similar to How to Write Inclusive Tech Docs

Comment on - New tools for teaching writing - april 20
Comment on - New tools for teaching writing  - april 20Comment on - New tools for teaching writing  - april 20
Comment on - New tools for teaching writing - april 20Jim (James) Buckingham
 
How to Communicate Your Research Results to Stakeholders: Practical Strategie...
How to Communicate Your Research Results to Stakeholders: Practical Strategie...How to Communicate Your Research Results to Stakeholders: Practical Strategie...
How to Communicate Your Research Results to Stakeholders: Practical Strategie...NGNAOUSSI ELONGUE Cedric Christian
 
Embedding Ethnography and UX at the University of York
Embedding Ethnography and UX at the University of York Embedding Ethnography and UX at the University of York
Embedding Ethnography and UX at the University of York Ned Potter
 
The importance of being communicative
The importance of being communicativeThe importance of being communicative
The importance of being communicativeFrieda Brioschi
 
Social media for umass boston
Social media for umass bostonSocial media for umass boston
Social media for umass bostonWerner Kunz
 
Composing the perfect research symphony – What are the key elements to conduc...
Composing the perfect research symphony – What are the key elements to conduc...Composing the perfect research symphony – What are the key elements to conduc...
Composing the perfect research symphony – What are the key elements to conduc...innogy Innovation GmbH
 
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...Jodie Nicotra
 
The importance of being communicative (vers. 2014)
The importance of being communicative (vers. 2014)The importance of being communicative (vers. 2014)
The importance of being communicative (vers. 2014)Frieda Brioschi
 
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...Integrating Telecollaboration into Foreign Language Education: Exploring Mo...
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...Robert O'Dowd
 
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...ZoopUp
 
Creating a Partnership Program for your Coworking Space
Creating a Partnership Program for your Coworking SpaceCreating a Partnership Program for your Coworking Space
Creating a Partnership Program for your Coworking SpaceChristoph Fahle
 
Developing international e-learning programmes - Oxfam GB
Developing international e-learning programmes - Oxfam GBDeveloping international e-learning programmes - Oxfam GB
Developing international e-learning programmes - Oxfam GBWalkgrove
 
Write My Narrative Essay For Me Affordable Writing Help
Write My Narrative Essay For Me  Affordable Writing HelpWrite My Narrative Essay For Me  Affordable Writing Help
Write My Narrative Essay For Me Affordable Writing HelpLesly Lockwood
 
Reflecting Upon Technical Writing
Reflecting Upon Technical WritingReflecting Upon Technical Writing
Reflecting Upon Technical WritingMichael Soto
 

Similar to How to Write Inclusive Tech Docs (20)

Comment on - New tools for teaching writing - april 20
Comment on - New tools for teaching writing  - april 20Comment on - New tools for teaching writing  - april 20
Comment on - New tools for teaching writing - april 20
 
How to Communicate Your Research Results to Stakeholders: Practical Strategie...
How to Communicate Your Research Results to Stakeholders: Practical Strategie...How to Communicate Your Research Results to Stakeholders: Practical Strategie...
How to Communicate Your Research Results to Stakeholders: Practical Strategie...
 
Social media for research
Social media for researchSocial media for research
Social media for research
 
Embedding Ethnography and UX at the University of York
Embedding Ethnography and UX at the University of York Embedding Ethnography and UX at the University of York
Embedding Ethnography and UX at the University of York
 
The importance of being communicative
The importance of being communicativeThe importance of being communicative
The importance of being communicative
 
Social media for umass boston
Social media for umass bostonSocial media for umass boston
Social media for umass boston
 
Sharing Knowledge Acuril08 MG
Sharing Knowledge Acuril08 MGSharing Knowledge Acuril08 MG
Sharing Knowledge Acuril08 MG
 
Composing the perfect research symphony – What are the key elements to conduc...
Composing the perfect research symphony – What are the key elements to conduc...Composing the perfect research symphony – What are the key elements to conduc...
Composing the perfect research symphony – What are the key elements to conduc...
 
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...
ENGL 202 Project 1 Slidedoc 1: How to do the Analyzing Professional Writing P...
 
The importance of being communicative (vers. 2014)
The importance of being communicative (vers. 2014)The importance of being communicative (vers. 2014)
The importance of being communicative (vers. 2014)
 
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...Integrating Telecollaboration into Foreign Language Education: Exploring Mo...
Integrating Telecollaboration into Foreign Language Education: Exploring Mo...
 
Slides For Longbridge V2
Slides For Longbridge V2Slides For Longbridge V2
Slides For Longbridge V2
 
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...
zoopup-com-blogs-details-crafting-universal-connections-a-guide-for-freelance...
 
Creating a Partnership Program for your Coworking Space
Creating a Partnership Program for your Coworking SpaceCreating a Partnership Program for your Coworking Space
Creating a Partnership Program for your Coworking Space
 
Developing international e-learning programmes - Oxfam GB
Developing international e-learning programmes - Oxfam GBDeveloping international e-learning programmes - Oxfam GB
Developing international e-learning programmes - Oxfam GB
 
Blogging 201
Blogging 201Blogging 201
Blogging 201
 
Write My Narrative Essay For Me Affordable Writing Help
Write My Narrative Essay For Me  Affordable Writing HelpWrite My Narrative Essay For Me  Affordable Writing Help
Write My Narrative Essay For Me Affordable Writing Help
 
The Art Of Blogging
The Art Of BloggingThe Art Of Blogging
The Art Of Blogging
 
Reflecting Upon Technical Writing
Reflecting Upon Technical WritingReflecting Upon Technical Writing
Reflecting Upon Technical Writing
 
MINITEX Webinar
MINITEX WebinarMINITEX Webinar
MINITEX Webinar
 

Recently uploaded

Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxLoriGlavin3
 
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...Nikki Chapple
 
A Glance At The Java Performance Toolbox
A Glance At The Java Performance ToolboxA Glance At The Java Performance Toolbox
A Glance At The Java Performance ToolboxAna-Maria Mihalceanu
 
A Framework for Development in the AI Age
A Framework for Development in the AI AgeA Framework for Development in the AI Age
A Framework for Development in the AI AgeCprime
 
Design pattern talk by Kaya Weers - 2024 (v2)
Design pattern talk by Kaya Weers - 2024 (v2)Design pattern talk by Kaya Weers - 2024 (v2)
Design pattern talk by Kaya Weers - 2024 (v2)Kaya Weers
 
Connecting the Dots for Information Discovery.pdf
Connecting the Dots for Information Discovery.pdfConnecting the Dots for Information Discovery.pdf
Connecting the Dots for Information Discovery.pdfNeo4j
 
Varsha Sewlal- Cyber Attacks on Critical Critical Infrastructure
Varsha Sewlal- Cyber Attacks on Critical Critical InfrastructureVarsha Sewlal- Cyber Attacks on Critical Critical Infrastructure
Varsha Sewlal- Cyber Attacks on Critical Critical Infrastructureitnewsafrica
 
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...Wes McKinney
 
Long journey of Ruby standard library at RubyConf AU 2024
Long journey of Ruby standard library at RubyConf AU 2024Long journey of Ruby standard library at RubyConf AU 2024
Long journey of Ruby standard library at RubyConf AU 2024Hiroshi SHIBATA
 
Landscape Catalogue 2024 Australia-1.pdf
Landscape Catalogue 2024 Australia-1.pdfLandscape Catalogue 2024 Australia-1.pdf
Landscape Catalogue 2024 Australia-1.pdfAarwolf Industries LLC
 
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)Mark Simos
 
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesHow to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesThousandEyes
 
Potential of AI (Generative AI) in Business: Learnings and Insights
Potential of AI (Generative AI) in Business: Learnings and InsightsPotential of AI (Generative AI) in Business: Learnings and Insights
Potential of AI (Generative AI) in Business: Learnings and InsightsRavi Sanghani
 
So einfach geht modernes Roaming fuer Notes und Nomad.pdf
So einfach geht modernes Roaming fuer Notes und Nomad.pdfSo einfach geht modernes Roaming fuer Notes und Nomad.pdf
So einfach geht modernes Roaming fuer Notes und Nomad.pdfpanagenda
 
QCon London: Mastering long-running processes in modern architectures
QCon London: Mastering long-running processes in modern architecturesQCon London: Mastering long-running processes in modern architectures
QCon London: Mastering long-running processes in modern architecturesBernd Ruecker
 
Zeshan Sattar- Assessing the skill requirements and industry expectations for...
Zeshan Sattar- Assessing the skill requirements and industry expectations for...Zeshan Sattar- Assessing the skill requirements and industry expectations for...
Zeshan Sattar- Assessing the skill requirements and industry expectations for...itnewsafrica
 
Genislab builds better products and faster go-to-market with Lean project man...
Genislab builds better products and faster go-to-market with Lean project man...Genislab builds better products and faster go-to-market with Lean project man...
Genislab builds better products and faster go-to-market with Lean project man...Farhan Tariq
 
Emixa Mendix Meetup 11 April 2024 about Mendix Native development
Emixa Mendix Meetup 11 April 2024 about Mendix Native developmentEmixa Mendix Meetup 11 April 2024 about Mendix Native development
Emixa Mendix Meetup 11 April 2024 about Mendix Native developmentPim van der Noll
 
Modern Roaming for Notes and Nomad – Cheaper Faster Better Stronger
Modern Roaming for Notes and Nomad – Cheaper Faster Better StrongerModern Roaming for Notes and Nomad – Cheaper Faster Better Stronger
Modern Roaming for Notes and Nomad – Cheaper Faster Better Strongerpanagenda
 
Scale your database traffic with Read & Write split using MySQL Router
Scale your database traffic with Read & Write split using MySQL RouterScale your database traffic with Read & Write split using MySQL Router
Scale your database traffic with Read & Write split using MySQL RouterMydbops
 

Recently uploaded (20)

Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
 
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...
Microsoft 365 Copilot: How to boost your productivity with AI – Part one: Ado...
 
A Glance At The Java Performance Toolbox
A Glance At The Java Performance ToolboxA Glance At The Java Performance Toolbox
A Glance At The Java Performance Toolbox
 
A Framework for Development in the AI Age
A Framework for Development in the AI AgeA Framework for Development in the AI Age
A Framework for Development in the AI Age
 
Design pattern talk by Kaya Weers - 2024 (v2)
Design pattern talk by Kaya Weers - 2024 (v2)Design pattern talk by Kaya Weers - 2024 (v2)
Design pattern talk by Kaya Weers - 2024 (v2)
 
Connecting the Dots for Information Discovery.pdf
Connecting the Dots for Information Discovery.pdfConnecting the Dots for Information Discovery.pdf
Connecting the Dots for Information Discovery.pdf
 
Varsha Sewlal- Cyber Attacks on Critical Critical Infrastructure
Varsha Sewlal- Cyber Attacks on Critical Critical InfrastructureVarsha Sewlal- Cyber Attacks on Critical Critical Infrastructure
Varsha Sewlal- Cyber Attacks on Critical Critical Infrastructure
 
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...
The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...
 
Long journey of Ruby standard library at RubyConf AU 2024
Long journey of Ruby standard library at RubyConf AU 2024Long journey of Ruby standard library at RubyConf AU 2024
Long journey of Ruby standard library at RubyConf AU 2024
 
Landscape Catalogue 2024 Australia-1.pdf
Landscape Catalogue 2024 Australia-1.pdfLandscape Catalogue 2024 Australia-1.pdf
Landscape Catalogue 2024 Australia-1.pdf
 
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)
Tampa BSides - The No BS SOC (slides from April 6, 2024 talk)
 
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesHow to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
 
Potential of AI (Generative AI) in Business: Learnings and Insights
Potential of AI (Generative AI) in Business: Learnings and InsightsPotential of AI (Generative AI) in Business: Learnings and Insights
Potential of AI (Generative AI) in Business: Learnings and Insights
 
So einfach geht modernes Roaming fuer Notes und Nomad.pdf
So einfach geht modernes Roaming fuer Notes und Nomad.pdfSo einfach geht modernes Roaming fuer Notes und Nomad.pdf
So einfach geht modernes Roaming fuer Notes und Nomad.pdf
 
QCon London: Mastering long-running processes in modern architectures
QCon London: Mastering long-running processes in modern architecturesQCon London: Mastering long-running processes in modern architectures
QCon London: Mastering long-running processes in modern architectures
 
Zeshan Sattar- Assessing the skill requirements and industry expectations for...
Zeshan Sattar- Assessing the skill requirements and industry expectations for...Zeshan Sattar- Assessing the skill requirements and industry expectations for...
Zeshan Sattar- Assessing the skill requirements and industry expectations for...
 
Genislab builds better products and faster go-to-market with Lean project man...
Genislab builds better products and faster go-to-market with Lean project man...Genislab builds better products and faster go-to-market with Lean project man...
Genislab builds better products and faster go-to-market with Lean project man...
 
Emixa Mendix Meetup 11 April 2024 about Mendix Native development
Emixa Mendix Meetup 11 April 2024 about Mendix Native developmentEmixa Mendix Meetup 11 April 2024 about Mendix Native development
Emixa Mendix Meetup 11 April 2024 about Mendix Native development
 
Modern Roaming for Notes and Nomad – Cheaper Faster Better Stronger
Modern Roaming for Notes and Nomad – Cheaper Faster Better StrongerModern Roaming for Notes and Nomad – Cheaper Faster Better Stronger
Modern Roaming for Notes and Nomad – Cheaper Faster Better Stronger
 
Scale your database traffic with Read & Write split using MySQL Router
Scale your database traffic with Read & Write split using MySQL RouterScale your database traffic with Read & Write split using MySQL Router
Scale your database traffic with Read & Write split using MySQL Router
 

How to Write Inclusive Tech Docs

  • 1. How to write inclusive tech documentation Lucie Le Naour
  • 2. Agenda • What is inclusive documentation? • Why should documentation be inclusive? • Some best practices • Q&A (or debate?) How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019
  • 3. Inclusivity Inclusive documentation is a documentation that takes into account all of its users, regardless of their gender, culture, abilities, etc. How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019 What is inclusive documentation? „The quality of trying to include many different types of people and treat them all fairly and equally.“ - Cambridge Dictionary Inclusive documentation
  • 4. Because you are writing for your user! How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019 Why should documentation be inclusive? This Photo by Unknown Author is licensed under CC BY-SA Rubber stamp template: www.presentationmagazine.com This Photo by Unknown Author is licensed under CC BY-SA THE USERYOU
  • 5. How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019 Some best practices Educate yourself… … by exchanging with the people in your life This Photo by Unknown Author is licensed under CC BY-SA-NC
  • 6. How to write inclusive tech documention - Lucie Le Naour Write the Docs Meetup - August 2019 Some best practices Educate yourself… … by paying attention to the news This Photo by Unknown Author is licensed under CC BY-NC
  • 7. How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019 Some best practices Use language as a tool! • Language shapes the way humans think: listen cognitive scientist Lera Boroditsky talk about it here. • The words you choose matter: latest studies show for example that the use of gender-neutral pronouns boosts positive feelings towards women and LGBT people, read about it here and here. • The words you choose definitely matter: AI using language corpora has been shown to reproduce human biases, read about it here and here.
  • 8. How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019 Some best practices Use language as a tool! © Lucie Le Naour
  • 9. How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019 Some best practices Use design as a tool! • Design your documentation for guidance: use multiple formats and place the information where different users need it, Microsoft explains it better here. • Steal from your UI/UX colleagues: start using inclusive visuals in your docs, read about it here.
  • 10. How to write inclusive tech documentation - Lucie Le Naour Write the Docs Meetup - August 2019 Q&A Shoot!