Carolyn Stransky: Humanizing Your Documentation | JSConf Iceland 2018
2,039 views · Published 5 April 2018 · 28:32 · Indexed 30 October 2026
Channel: JSConf · 2018 · Science & Technology
https://2018.jsconf.is/speakers/carolyn-stransky/ It’s no secret that most people don’t read technical documentation for pleasure. Users often come to your docs when they are frustrated with your software, disappointed that they haven't been able to solve the problem on their own and generally feeling pretty low. This is a little sad, yeah, but being aware of these feelings is key for developers and technical writers. These emotions frame the reader’s perspective and therefore, should shape the mood of our docs. After all, when you've been stuck on a bug for hours, do you really want to read something saying 'but this is so easy'? In this talk, we’ll discuss how the language we use affects our users and the first steps towards writing accessible, approachable and use case-driven documentation.
More from this channel
-
29:49
Michael Bebenita & Shu-yu Guo: Low Level JavaScript
-
29:19
Michael Starzinger: The Footprint of Performance
-
27:17
Florian Loitsch: JavaScript as a compilation target - Making it fast
-
32:24
Jing Jin & Matthew Delaney: The Web's Black Magic
-
31:38
Anders Heijlsberg & Luke Hoban: Introducing TypeScript
-
24:59
Kevin Markman: Taking Web Apps Offline
-
26:28
Max Krohn: IcedCoffeeScript
-
30:46
Sam Dutton: WebRTC: Real-time communication without plugins