Humanizing Your Documentation
By 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 sad, sure, but being aware of these feelings is key for developers and technical writers alike. These emotions frame the reader’s perspective and therefore, should shape the mood of our docs. 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.
SOFTWARE ENGINEER, EMNIFY
Carolyn (she/her) is a software engineer and former technical writer based in Berlin, Germany. She’s currently working as a documentation engineer at emnify, the leading cloud building block for cellular communications in the IoT stack. Out of office, Carolyn is a freelance journalist and writes about the intersections of technology and intimacy for outlets like Future of Sex, Autostraddle, Silicon Allee and elsewhere.