Writing effective documentation | Beth Aitman |

Описание: Video sponsor: BuildKite (https://buildkite.com/)

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

But we often don't get round to writing documentation, because it's kind of a pain, and we don't know where to begin. So in this talk, I'll give a primer on writing effective documentation, and on helping your team to write docs too. Covering:

What makes documentation useful
How to make it easier to get started
How to make writing clear and readable

About Beth Aitman
Beth Aitman is a technical writer at Google, where she works to improve developer experience for Site Reliability Engineers. She’s interested in the intersection between UX and writing, and is passionate about teaching developers to write good docs. Outside of work, she likes to run around, climb rocks, and solve cryptic crosswords.

Find out more: https://berlin2019.theleaddeveloper.c...

Lead Dev is a community for technical leaders. We have a series of conferences and meetups designed with the needs and pain points of technical team leads in mind. We programme each conference around our three key themes of Team, Tech & Tools. The talks are designed to help very practically with common problems in these areas. To find out more about us, visit:
https://theleaddeveloper.com/