Documentation in practice
May 25, 2019, 3:15 p.m. - 3:55 p.m.
At Divio, Daniele has developed a documentation system that has been widely presented and adopted by other organisations and in other projects. In this talk, He will look at some practical issues that they and other organisations have faced.
As a system for thinking about and structuring documentation, this method solves many problems that maintainers face, bringing clarity and simplicity to untidy and complex material.
As a system for thinking about and structuring documentation, this method solves many problems that maintainers face, bringing clarity and simplicity to untidy and complex material.
The real world however is in fact untidy, complex and full of irritating edge-cases, that often seem to resist being placed into neat and tidy structures. How well does the system cope with this? What can be done when it appears that the material fits the structure poorly? How can we minimise the extra work we will inevitably create for ourselves when we make wrong decisions that we need to correct later (something that happens in all kinds of projects)?
