Playback starts YouTube’s embedded player (privacy-enhanced mode).
How to Write Documentation for People that Don't Read
ChannelNext Day VideoDescription from the creator
Kevin Burke
lanyrd.com/2015/writethedocs/sdmwxy/
It's 3AM, do you know where your users are? If people want to learn how to use your product, where are they looking for help? Are they on your site, and if they're on your site, are they finding the right page?
Usability researchers have known for decades that users don't read word by word - they scan for the content they want.
If users can't make heads or tails of your documentation, they'll give up (a loss of revenue), remain ignorant of product features (another loss of revenue) or ask needless support questions (an increased cost).
In this talk we'll examine the findability of your documentation, and the text on the pages in your documentation. We'll examine usability research into how users read, look at several ways your documentation is failing busy users, and the lessons I learned conducting user tests at Twilio. We'll learn more about how users find the answers they are looking for, and the importance of spreading clear writing across not just your documentation, but your headlines and error messages in your API.
lanyrd.com/2015/writethedocs/sdmwxy/
It's 3AM, do you know where your users are? If people want to learn how to use your product, where are they looking for help? Are they on your site, and if they're on your site, are they finding the right page?
Usability researchers have known for decades that users don't read word by word - they scan for the content they want.
If users can't make heads or tails of your documentation, they'll give up (a loss of revenue), remain ignorant of product features (another loss of revenue) or ask needless support questions (an increased cost).
In this talk we'll examine the findability of your documentation, and the text on the pages in your documentation. We'll examine usability research into how users read, look at several ways your documentation is failing busy users, and the lessons I learned conducting user tests at Twilio. We'll learn more about how users find the answers they are looking for, and the importance of spreading clear writing across not just your documentation, but your headlines and error messages in your API.
About this tutorial
Next Day Video published this 28:53 video tutorial on October 25, 2015. It has been watched 8,164 times on YouTube.
- Channel
- Next Day Video
- Category
- People & Blogs
- Duration
- 28:53
- Published
- October 25, 2015
- Views
- 8,164
- Likes
- 120
Tags
Share
This tutorial in other languages
- FRComment écrire la documentation pour les personnes qui ne savent pas lire
- ESCómo escribir documentación para las personas que no leen
- PTComo escrever documentação para pessoas que não lêem
- ITCome scrivere la documentazione per le persone che non leggono
- DEHow to Write Dokumentation für Menschen, die nicht lesen
- NLHoe te Documentatie schrijven voor mensen die niet lezen
- RUКак написать документацию для людей, которые не читают
- PLJak napisać Dokumentacja dla osób, które nie czytają
- JAない読むことを人々のドキュメントを書く方法
- ARكيفية كتابة وثائق الناس أن لا تقرأ
- HIलोगों के लिए प्रलेखन कैसे लिखें ऐसा नहीं कर पढ़ें
- IDCara Menulis Dokumentasi untuk Orang yang Jangan Baca