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.

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