Search results

Moved AI pages into their own collection and space

by Tom Johnson on Jan 20, 2024
categories: ai api-doc-site-updates

I recently moved the AI section from my API course into their own dedicated collection and space at /ai. I moved these AI pages into their space for one main reason: I anticipate writing a lot more about AI, and this content was outgrowing its chapter in the API documentation course.

The API documentation course is already more than 900 pages when printed as a PDF, and I didn’t want to expand the PDF beyond this already length. By putting the AI content into its own space, it will be easier for readers to find and navigate the content. The highest interest right now for many tech writers is to understand how to apply AI to documentation techniques, workflows, and processes.

AI section for content
I moved the AI content into its own section and added links to the top navigation

See the AI-powered docs menu on my top navigation. This menu has two options:

  • AI-powered documentation: Contains use cases for using AI with tech comm, including prompt engineering techniques for doc scenarios and more.
  • AI category posts: Contains all the posts that I’ve added to my ai category.

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, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.