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.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include the following technical communication topics: Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, and certificate programs. I'm interested in information design, API documentation, visual communication, information architecture and findability, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.