Document 360: #1 Knowledge Base Software
Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,400+ subscribers

Search results

Document 360: #1 Knowledge Base Software

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

by David CHEN 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.

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.

follow us in feedly