Search results

Using AI to mine log messages from reference doc builds (Prompt engineering series)

by Tom Johnson on Dec 19, 2024
categories: ai

I added a new post on my Prompt engineering series about using AI to mine log messages. This post describes how to use AI to identify important information from scripts that build your reference docs—information such as warnings about missing documentation or deviations from engineering style. These log messages often whiz by in the terminal during builds, even when those builds are successful. It would be tedious to try to manually read the extensive logs and find relevant messages. AI can help turn the logs into actionable information, identifying warnings about missing documentation.

Read the post: Using AI to mine log messages from reference doc builds.

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.

© 2026 Tom Johnson