Tomorrow's TeX Hour continues from last month's topic: Better Technical Documentation.
Last month's meeting was based on a "needs discovery" meeting organised by Daniele Procida, who I've met several times at UK Python conferences. Daniele is now one of several Directors of Engineering at Canonical, the developers of Ubuntu Linux, where he has special responsibility for improving both documentation and the process by which it is created.
Daniele is now giving 3 weekly 2 hour workshops to research software engineers. Tomorrow's TeX Hour is based on my experience of the first two workshops. Here's my core of last week's workshop.
People have different modes of activity. Common modes are sitting, standing and lying. Listening, talking and observing. Common modes related to tools are handling a tool, using a tool, creating a tool and understanding a tool. Software documentation works better when it fits the mode of activity. To be useful, this knowledge must be incorporated into experience and practice.
The third and final workshop next week will be on tooling, with a focus on the Sphinx system, which was created especially for the core Python documentation. It's been in use since 2008. The previous system used LaTeX as the input syntax. Sphinx uses the specially developed RST markup language.
This week's TeX Hour is: Thursday 17 March, 6:30 to 7:30pm UK (and UTC) time.
with best regards