Speaker
Description
One of the best ways to improve your own software, or to become involved in open-source software contribution, is by creating and improving documentation.
Everyone knows that better documentation makes software projects more successful - but many people have a difficult, unhappy time trying to do it.
The problem is knowing how to do it.
The Diátaxis approach to documentation is widely adopted (including by Canonical, and eventually, for Ubuntu). It has become popular because it helps remove uncertainty and doubt about how to do documentation.
Whether you are a project maintainer or a documentation contributor, you'll find that this workshop gives you some valuable new understanding and some practical methods to help you with documentation.
This is a hands-on and fully interactive workshop. It introduces the principles of Diátaxis through collaborative exercises. There'll be plenty of time for discussion and your questions.
At the end of it, you will feel more confident about doing software documentation, and you will have a clearer picture of the direction to take towards documentation success.
Session author bios
Daniele is a Director of Engineering at Canonical, where he leads documentation practice across the whole organisation. He is the author of the Diátaxis documentation framework.
He has been involved in open-source communities for many years, as a contributor and organiser: Python, Django and especially the African open-source software movement.
| Level of Difficulty | Beginner |
|---|---|
| Social Media | @EvilDMP on Twitter |