Search results

API quick reference guides (and the challenges of passing long content into AI contexts)

by Tom Johnson on Jun 1, 2025
categories: api-doc • quick-reference-guides • ai • technical-writing

In my prompt engineering series, I added an article exploring how API quick reference guides (QRGs) can improve developer usability and also augment AI chat sessions with much-needed context. These QRGs are structured as hierarchical tree diagrams providing a visual map to complex APIs. The diagrams make it easier for developers to navigate and understand relationships between elements compared to traditional flat reference documentation. The article also includes a step-by-step process for creating these QRGs using AI.

Read the full article here: API quick reference guides (and the challenges of passing long content into AI contexts).

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.

© 2025 Tom Johnson

OSZAR »