[accessibility] TeX Hour tomorrow: More on Better Technical Documentation

[Jonathan Fine]

Hi

Tomorrow's TeX Hour continues from last month's topic: Better Technical
Documentation.

Date and time: Thursday 17 March, 6:30 to 7:30pm UK (and UTC) time.
UK time now: https://time.is/UK.
Zoom URL:
https://us02web.zoom.us/j/78551255396?pwd=cHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09

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.
https://www.sphinx-doc.org/en/master/

Last month's TeX Hour on Better Technical Documentation
https://youtu.be/gbBNuUOWF0c
Last week's TeX Hour on CLI and text interfaces, Python syntax errors
https://youtu.be/E6jXQMRvVcg

This week's TeX Hour is: Thursday 17 March, 6:30 to 7:30pm UK (and UTC)
time.
UK time now: https://time.is/UK.
Zoom URL:
https://us02web.zoom.us/j/78551255396?pwd=cHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09

with best regards

Jonathan
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://tug.org/pipermail/accessibility/attachments/20220316/45943403/attachment.html>