TeX Hour tonight: Better Technical Documentation: 18:30 UTC time

--0000000000004da9cf05d8c36da9
Content-Type: text/plain; charset="UTF-8"

Hi

Tonight's TeX hour is from 6:30 to 7:30pm UK (and UTC) time. The UK time
now: https://time.is/UK.
The zoom URL is
https://us02web.zoom.us/j/78551255396?pwd=cHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09

Last week I attended 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 also a current Fellow of the Software Sustainability Institute.
The meeting last week was to discover needs for a workshop he's holding
next month, to help Research Software Engineers improve their
documentation. There were over 20 people there.

I hope that at tonight's TeX Hour we will share our experience of writing,
rendering and using technical documentation, particularly  for software.
Daniele's approach is focussed on a quadrant of user needs.

The quadrant is

Top left: Tutorials (focussed on learning).
Top right: How-to guides (focussed on tasks).
Bottom left:  Explanation (focussed on understanding).
Bottom right: Reference (focussed on information).

The up-down axis is practice and theory. The left-right axis is study and
work.

Interested? Reflect on your own documentation experience, and visit:

https://www.software.ac.uk/about/fellows/daniele-procida
https://diataxis.fr/
https://mail.python.org/pipermail/python-uk/2022-February/004828.html

Tonight's TeX hour is from 6:30 to 7:30pm UK (and UTC) time. The UK time
now: https://time.is/UK.
The zoom URL is
https://us02web.zoom.us/j/78551255396?pwd=cHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09

wishing you beautiful and effective documents

Jonathan

--0000000000004da9cf05d8c36da9
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div class=3D"gmail_quote"><div dir=3D"ltr"><div class=3D"=
gmail_quote"><div dir=3D"ltr"><div class=3D"gmail_quote"><div dir=3D"ltr">H=
i<div><br></div><div><div>Tonight&#39;s TeX hour is from 6:30 to 7:30pm UK =
(and UTC) time. The UK time now: <a href=3D"https://time.is/UK" target=3D"_=
blank">https://time.is/UK</a>.</div><div>The zoom URL is <a href=3D"https:/=
/us02web.zoom.us/j/78551255396?pwd=3DcHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09" targ=
et=3D"_blank">https://us02web.zoom.us/j/78551255396?pwd=3DcHdJN0pTTXRlRCtSd=
1lCTHpuWmNIUT09</a></div><div><div><br></div><div>Last week I attended a &q=
uot;needs discovery&quot; meeting organised by Daniele Procida, who I&#39;v=
e met several times at UK Python conferences. Daniele is now one of several=
 Directors of Engineering at Canonical, the=C2=A0 developers of Ubuntu Linu=
x, where he has special responsibility for improving both documentation and=
 the process by which it is created.</div><div><br></div><div>Daniele is al=
so a current Fellow of the Software Sustainability Institute. The meeting l=
ast week was to discover needs for a workshop he&#39;s holding next month, =
to help Research Software Engineers improve their documentation. There were=
 over 20 people there.</div><div><br></div><div>I hope that at tonight&#39;=
s TeX Hour we will share our experience of writing, rendering and using tec=
hnical documentation, particularly=C2=A0 for software. Daniele&#39;s approa=
ch is focussed on a quadrant of user needs.=C2=A0</div><div><br></div><div>=
The quadrant is</div><div><br></div><div>Top left: Tutorials (focussed on l=
earning).=C2=A0</div><div>Top right: How-to guides (focussed on tasks).</di=
v><div>Bottom left:=C2=A0 Explanation (focussed on understanding).</div><di=
v>Bottom right: Reference (focussed on information).</div><div><br></div><d=
iv>The up-down axis is practice and theory. The left-right axis is study an=
d work.=C2=A0</div><div><br></div><div>Interested? Reflect on your own docu=
mentation experience, and visit:</div><div><br></div><div><a href=3D"https:=
//www.software.ac.uk/about/fellows/daniele-procida" target=3D"_blank">https=
://www.software.ac.uk/about/fellows/daniele-procida</a><br></div><div><a hr=
ef=3D"https://diataxis.fr/" target=3D"_blank">https://diataxis.fr/</a><br><=
/div><div><a href=3D"https://mail.python.org/pipermail/python-uk/2022-Febru=
ary/004828.html" target=3D"_blank">https://mail.python.org/pipermail/python=
-uk/2022-February/004828.html</a></div><div><br></div><div><div>Tonight&#39=
;s TeX hour is from 6:30 to 7:30pm UK (and UTC) time. The UK time now: <a h=
ref=3D"https://time.is/UK" target=3D"_blank">https://time.is/UK</a>.</div><=
div>The zoom URL is <a href=3D"https://us02web.zoom.us/j/78551255396?pwd=3D=
cHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09" target=3D"_blank">https://us02web.zoom.us=
/j/78551255396?pwd=3DcHdJN0pTTXRlRCtSd1lCTHpuWmNIUT09</a></div></div><div><=
br></div><div>wishing you beautiful and effective documents</div><div><br><=
/div><div>Jonathan</div><div><br></div><div><br></div></div></div></div>
</div></div>
</div></div>
</div></div>

--0000000000004da9cf05d8c36da9--