Search results

Chapter 12: Thriving in the API doc space

Last updated: May 28, 2023

Download PDF

Getting a job in API documentation requires you to have some familiarity programming languages, experience writing developer docs, and a portfolio of writing samples. Chances are, hiring managers will want you to be tech savvy and comfortable working in code, with less to say about your actual writing skills. While opportunities for API documentation roles exist globally, tech hubs such as California, Texas, New York, and Virginia have a higher concentration of these jobs. If you need to build up a writing portfolio, consider contributing to open source projects and creating sample API reference documentation.

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.

114% Complete

114/177 pages complete. Only 63 more pages to go.
https://idratherbewriting.com/learnapidoc/jobapis.html
idratherbewriting.com
CC-MAIN-2023-50
52457
application/http; msgtype=response
sha1:VQ6OBEIQUFZ34LADWZ4BRNWK7FNZVSXH
<urn:uuid:47d816f2-997d-4c54-9c4a-9f93873aeb45>
2023-12-06T18:10:27Z
104.21.74.225
text/html
sha1:ULNDQAKOEQCDRSM7Y2T6ETRMRDYUYQN5
<urn:uuid:cf1834b0-4574-4620-abf8-f62f38f0b955>
https://idratherbewriting.com/learnapidoc/jobapis.html
response
<urn:uuid:8421f283-6fcf-408f-9123-31cbec77a651>
isPartOf: CC-MAIN-2023-50
publisher: Common Crawl
description: Wide crawl of the web for November/December 2023
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-156
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/