Find, Scan, Read: A Structured Approach to Documentation Creation & Improvement
Details
๐ Many lone Technical Writers and Technical Documentation Managers are faced with a common challenge. They are either told to create a documentation set or asked to improve an existing documentation set. This is no easy task, which can be overwhelming.
In this talk, Gareth Brinn, Senior Technical Writer at Gravitee will talk about how he approached such a challenge. He will discuss how he structured his goals just like a user would approach reading his documentation. They have to find the documentation, scan the documentation, and then read the documentation. By following the same path as his reader, Gareth was able to create small, attainable goals that made big impacts to the documentation.
๐๏ธ Agenda
When: Thursday 20 November, from 6.30pm
Where: Wallacespace Spitalfields ( 15 Artillery Ln, London E1 7HA )
What:
18.30 - 19.00 Arrival
19.00 - 19.10 Welcome & Housekeeping
19.10 - 19.40 Part 1 of presentation
19.40 - 20.00 Break
20.00 - 20.30 Part 2 of presentation
20.30 - 21.00 Closing and networking
All times are approximate.
๐ How to find us:
Look for WTD signs and organisers.
Map pin
๐ธ Photos:
Note that the organizers will take some photos for the WTD group.
---
Gravitee, leader in the 2024 Gartner Magic Quadrantโข for API management, enables you to securely and easily manage event streams and agentic AI alongside traditional APIs, bringing all your APIs together, regardless of gateway, broker, or agent. Gravitee allows you to overcome the constant constraints of security concerns, inflexible tech, and lack discoverability with a platform that brings all your APIs together so you can Hold Nothing Back.