This talk was presented at API The Docs Virtual 2020 event series on 24 June. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit our talk recaps ToC page for an overview of all presentations!
New Relic hired an external trainer to teach members of the Tech Docs and UX teams REST API documentation best practices.
Tthe team members already learnt about API reference writing through documenting them, and from classes aimed at engineers. Emphatic knowledge gaps appeared on a fundamental level.
Consider the audience: mixed background, typical techwriter level but not engineer --» explain technical topics more slowly, explicitly. Do not assume programming experience: Fine-tune to audience needs because training takes a lot of resources. Small class.
Adjust agenda to student interest, address concepts.
Ensure low-friction interactivity, but not command-performance: frequently scheduled breaks for questions.
Liven up tech content: move out of technology often, with interesting and relevant examples.
The 80/20 rule: teach the first 20%, and students can self-teach the rest if they meet it.
Boundaries around content for beginners, to inspire and empower, to reduce impostor syndrome or paralysis from overwhelm.
Multimodal learning: first learn. Then practice in frequent small labs. Then make students answer other students' questions, the act of explanation consolidates their own understanding.
Higher confidence in discussions on:
Being able to ask more directed, particular questions around the APIs they are documenting.
“In essence, creating an accessible developer portal ensures that you provide a better user experience to the wides… https://t.co/27qHNJQiSC