Zsuzsa Nagy will be giving a presentation at TCUK18 entitled “‘Docs as code’ without any code”.
‘Docs as Code’ is an approach to writing user documentation using the same tools, and following the same processes as software developers. Arm’s Architecture Information Group is using ‘Docs as Code’ principles on large manuals that do not accompany products: they are the products.
- We author content in almost plain text (Markdown).
- We use distributed version control (git).
- We conduct reviews on small batches (Gerrit).
This talk will report on the collaboration practices between engineer contributors and technical authors. It will also describe the skill development opportunities ‘Docs as Code’ offers for technical authors in this Arm team.
About Zsuzsa Nagy
Zsuzsa Nagy has 15 years of experience in the field of information design and is a Fellow of the ISTC. For the past 8 years, she has worked for Arm in Cambridge as an information developer, most recently on processor architecture documents. She holds an MA in Linguistics from Rutgers (US), and a Diploma in Software Development from the Open University (UK).