For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

Two-Minute Video to Convince Others of the Value of Technical Documentation

by Tom Johnson on Oct 29, 2008
categories: technical-writing • screencasting

On the Technical Writers of India listserv, someone is trying to get his company to realize the value of technical communication by showing a humorous video on bad documentation that he can use during training. "The idea is to evoke laughter, and keep the audience engaged throughout my presentation."

Okay, hands-down, this is the best video to show. Hat tip to Holly Harkness and Karen Shriver for finding this.

Sponsored

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.