DevConf.US '18 has ended
DevConf.us 2018 is the 1st annual, free, Red Hat sponsored technology conference for community project and professional contributors to Free and Open Source technologies held at the Boston University in the historic city of Boston, USA.

When: Friday, August 17 to Sunday, August 19, 2018

Venue: Boston University, George Sherman Union Building
Back To Schedule
Sunday, August 19 • 1:40pm - 2:15pm
What Coding Taught me about Writing Documentation

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.
Before becoming a technical writer, I spent over 15 years writing code for switching software. As a developer, my goal for technical documentation was to describe the functionality of the coding project. I would describe how the code worked and how it interacted with the system. I discovered that this was not the best approach for customer documentation and that the best approach is to write with the user in mind.
In this talk, I will draw upon my experience as a technical writer for Red Hat Developer Suite to:
* discuss how use case driven documentation provides the best user experience
* give best practices for writing with the user in mind and writing for a wider audience
* walk through changing content to a use case driven approach

avatar for Petra Sargent

Petra Sargent

Red Hat
Petra became involved in the Openstack community through Outreachy internship. She has attended 2 OpenStack summits and co-chaired the Getting Started track for the summit in Barcelona.Petra Sargent has over 17 years experience in proprietary software development where she served... Read More →

Sunday August 19, 2018 1:40pm - 2:15pm EDT
Metcalf Small Boston University, George Sherman Union Building