Rust docs - A practical guide to making good documentation - Rust Zürichsee Meetup

Today we are very excited to have Beth Aitman give a practical guide to making good documentation in Rust (and other programming languages)!

The goal of this talk is to make it much less painful for you to write documentation - and possibly even enjoyable. She will give you a practical guide to writing effective documentation, and the conceptual background you need to understand the problem space.

We'll cover:

  • what to write, and how to work out what you need to write
  • tips for making your writing clear and easy-to-read
  • making docs work for your audience (aka - when it is and isn't appropriate to talk about category theory)
  • maintenance and testing

with plenty of examples of good and bad along the way.

You can signup on our meetup page.

links

social