This is the third in a series of courses for technical writers who want to learn how to write API documentation. The first two courses are called “Learn API Technical Writing: JSON and XML for Writers” and “Learn API Technical Writing: REST for Writers”, and it’s recommended that you first take those courses unless you are very familiar with API documentation, and how to document reference material.
This course teaches how to write conceptual Swagger API Documentation, such as overviews, getting started sections, and tutorials. For the most part, no programming experience is required, but technical writers with programming experience will still find it useful.
In addition to conceptual material, this course covers guidelines for good sample code, tools for making REST requests, and how to find an open-source project to document as a way to get into the field of API writing.
What are APIs?
APIs (Application Program Interfaces) define how software systems talk to each other, and API documentation is a rapidly growing field. There is a strong need for writers who can understand APIs and explain to them so that software developers can understand how to use them. API writers get to be in on the cutting edge of technology in high-paying positions.