Search results

Using long-token contexts to quality check an entire API doc set

by Tom Johnson on Jul 15, 2024
categories: ai • api-doc

One of the advantages of recent Gen AI updates is the massive token input context. When you can pass in an entire set of documentation as an input, you have a much stronger possibility for powerful prompts. In these prompts, the reference docs can serve as a key source of truth. User guide content and drift out of date, but a freshly generated reference doc should be accurate to the code base, for the most part. From this source of truth, you can do all sorts of things, such as identify outdated content in the user guide, see what's new between outputs, get links in your release notes, and more. In this article, I share 8 quality control prompts you can use when passing in your entire reference docs.

Read the article here: Using long-token contexts to quality check an entire API doc set.

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.

© 2024 Tom Johnson