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

New section in API documentation course: The Job Market for API technical Writers

by Tom Johnson on Feb 8, 2016
categories: api-doc

I added a new section to my API documentation course called The Job Market for API technical Writers. In this section, I try to elaborate on why knowledge of programming is often listed as a requirement in API documentation jobs, even if you're mainly documenting a REST API.

In postings for API documentation jobs, you’ll often see requirements like this:

“Ability to read code in one or more programming languages, such as Java, C++, or Python.”

Although your core task may be to document a REST API, most likely there will be numerous client implementations in different programming languages that you will also need to document.

Sponsored

The variety of programming languages creates challenges for technical writers, especially when employers want technical writers, from day one, to already be proficient in every language needed. In this new jobs section, I try to dive into this topic with more depth. You can read the new section here: The Job market for API technical writers.

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.