Writing Effective Documentation Beth Aitman #LeadDevBerlin

Writing Effective Documentation Beth Aitman #LeadDevBerlin

HomeLeadDevWriting Effective Documentation Beth Aitman #LeadDevBerlin
Writing Effective Documentation Beth Aitman #LeadDevBerlin
ChannelPublish DateThumbnail & View CountDownload Video
Channel AvatarPublish Date not found Thumbnail
0 Views
Video sponsor: BuildKite (https://buildkite.com/)

Documentation can make a big difference. Internal documentation can speed up your team and make it easier for new engineers to get started. External documentation reduces time spent on support questions and makes your product more user-friendly.

But we often don't get around to writing documentation because it's quite tedious and we don't know where to start. In this talk, I'll give you an introduction to writing effective documentation and how you can help your team write documentation too. The following topics will be covered:

What makes documentation useful
This makes getting started easier
This makes writing clear and readable

About Beth Aitman
Beth Aitman is a technical writer at Google, where she works to improve the developer experience for site reliability engineers. She is interested in the intersection of UX and writing, and is passionate about teaching developers to write good documentation. Outside of work, she enjoys running around, climbing rocks, and doing crossword puzzles.

Learn more: https://berlin2019.theleaddeveloper.com/talks#beth-aitman

Lead Dev is a community for technical leaders. We offer a series of conferences and meetups tailored to the needs and pain points of technical team leaders. Each conference is organized around our three main themes of team, technology and tools. The talks are designed to provide practical help with common problems in these areas. For more information about us, visit:
https://theleaddeveloper.com/

Please take the opportunity to connect with your friends and family and share this video with them if you find it useful.