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

New API doc course topic: Using AI to create doc updates based on bugs

by Tom Johnson on Aug 9, 2023
categories: ai • api-doc-site-updates

I added a new article to my API course about using AI to create doc updates based on bugs. By bugs, I'm referring to small issues often surfaced by users about the docs. Bugs are often long lists of random fixes to make with the docs, often involving a small number of changed lines. However, interpreting the bugs can be challenging. Fortunately, AI tools can help you understand the issue and resolution.

Read the article here: Using AI to create doc updates based on bugs.

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.