Get your documentation right

This workshop introduces, and helps you implement, an approach that will improve your project’s documentation.

This approach focuses on documentation structure. Based on sound, well-established principles concerning a number of topics (including learning, understanding, praxis, pedagogy amongst others) it provides a documentation framework that is easy to understand, straightforward to put into practice, and above all, immediately and enduringly effective.

In the workshop we’ll use a hypothetical documentation set for examples, but attendees should have some actual documentation - whether already extant or in the planning phase - to apply it.

The principles used in this workshop are outlined at https://www.divio.com/en/blog/documentation/. This work has been presented in numerous conference talks, such as https://www.youtube.com/watch?v=t4vKPhjcMZg.

It has been applied successfully to many software projects, making the documentation better for users, and more manageable for its maintainers.