Berlin

November 4 & 5, 2024

New York

September 4 & 5, 2024

London

June 16 & 17, 2025

Writing effective technical documentation

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.

Speakers: Beth Aitman

Register or log in to access this video

Create an account to access our free engineering leadership content, free online events and to receive our weekly email newsletter. We will also keep you up to date with LeadDev events.

Register with google

We have linked your account and just need a few more details to complete your registration:

Terms and conditions

 

 

Enter your email address to reset your password.

 

A link has been emailed to you - check your inbox.



Don't have an account? Click here to register
August 03, 2020

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