Kate sounds off on instructional design
In this solo episode, I share my latest content updates progress and confess to finally jumping on the Claude Code bandwagon. I also reflect on my takeaways from Katie Cox’s interview (S3:E44) and some of the instructional design concepts she shared that most resonated with me.
—
I finally finished my Minimum Viable Docs (MVD) list from the article editor layout release, four months later. I also finally gave in to using Claude Code when I needed to overhaul and update our OpenAPI spec file for our API documentation. My usage began innocently enough, trying to catch issues upgrading from version 2.x to 3.0 of the OpenAPI spec, but eventually included upgrading to version 3.1, updating Redoc, and overhauling a lot of the structure. Along the way, I still relied a lot on human expertise, in the form of API docs feedback from our developer Sue and OpenAPI technical expertise from Lorna Mitchell. I ultimately created a Claude skill that checks for valid YAML, validity against the OpenAPI spec file, validity against the Redoc linter CLI, and a few style guide choices.
I also reflect on my interview with Katie Cox, noting that there are a ton of ways that instructional design and technical writing overlap in terms of the skillset, the day-to-day work, and the focus on end-user needs. The primary difference, to me, lies between what a reader expects versus what a learner expects. I appreciated Katie’s focus on encouraging self-directed learning and not gating content behind clicks and required interactions. And I’m most looking forward to pairing learning objectives with a compelling narrative, one of the key tricks she uses in her work.
In this episode:
- [00:00:28]: Kate’s progress updates
- [00:01:42]: Kate’s long tangent about using Claude Code to update her OpenAPI spec file
- [00:16:48]: Kate’s reflections on Katie Cox’s episode
Resources discussed in this episode:
- KnowledgeOwl’s API endpoint reference documentation
- Developer collaboration with Lorna Mitchell (S3:E2)
- KnowledgeOwl’s API keys documentation
- Making the leap from tech writing to customer education with Katie Cox (S3:E44)
- The Accidental Instructional Designer by Cammy Bean
Join the discussion by replying on Bluesky
—
Contact The Not-Boring Tech Writer team:
We love hearing your ideas for episode topics, guests, or general feedback:
Contact Kate Mueller:
Contact KnowledgeOwl:
Creators and Guests
Host
Kate Mueller
Kate is a documentarian and knowledge base coach based in Midcoast Maine. When she's not writing software documentation or advising on knowledge management best practices, she's out hiking and foraging with her dog. Connect with her on LinkedIn, Bluesky, or Write the Docs Slack.
Producer
Chad Timblin
Chad is the Head of Podcast Operations / Co-Producer for The Not-Boring Tech Writer. He’s also the Executive Assistant to the CEO & Friend of Felines at KnowledgeOwl, the knowledge base software company that sponsors The Not-Boring Tech Writer. Some things that bring him joy are 😼 cats, 🎶 music, 🍄 Nintendo, 📺 Hayao Miyazaki’s films, 🍃 Walt Whitman’s poetry, 🌊 Big Sur, and ☕️ coffee.
