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

This question wasn't part of my survey, but it was part of another survey. I thought the results were relevant enough to include here as part of this series.

A 2013 survey by Programmable Web that included about 250 respondents found that complete and accurate documentation was the most important factor in an API: completedoc

This is certainly an encouraging finding for technical writers, and suggests that more attention and focus should be given to documentation. I think I'm going to print this picture out and tape it on my office wall.

Why is documentation so important for APIs in contrast to GUI-based products? API documentation is important because it is the interface for the product. With APIs, there is no user interface that people can figure out on their own. If you don't have clear and accurate documentation, the developer won't figure out how to use the API. Can you imagine guessing what an endpoint might be, or what parameters it takes?

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.