SDK Bridge offers online courses in learning the art of writing API documentation.
“SDK Bridge’s third course in the series on API documentation is clear and useful, with real-world examples and easy-to-follow steps. What a pleasure to learn from an expert who also knows how to teach. Highly recommend all of SDK Bridge‘s courses. They are outstanding.” – Susan, Udemy student
“Comprehensive, super-well-organized, clear, and concise.” – Emily, Udemy student
API Documentation 1: JSON and XML for Technical Writers
This course is for technical writers who want to learn how to document structured data, which is an important part of API documentation. In particular, it focuses on the two most popular structured data formats: JSON and XML. If you are new to API documentation, this is a great place to start. No programming experience is required, but technical writers with programming experience may still find it useful.
Time: 2.5 hours
Over 3000 students enrolled
API Documentation 2: REST for Technical Writers
Once you’ve learned about structured data, this course will teach you about how to document REST API requests, responses, and authentication. REST (Representational State Transfer) is the most popular form of web APIs. Again, no programming experience required, but writers with programming experience may find it useful.
Time: 3.5 hours
Over 2000 students enrolled
API Documentation 3: The Art of API Documentation
For technical writers who already understand how to write reference material for either web APIs or platform (programming language) APIs, this course covers overviews, getting started sections, tutorials, sample code, tools for calling REST APIs (cURL and Postman), and how to find an open source project to document.
This is a high-level course, but there are hands-on exercises for cURL and Postman.
Time: 1.5 hours
Over 900 students enrolled
Learn Swagger and the Open API Specification
The Open API Specification (often called “Swagger”) is currently the most popular way to create definitions of RESTful APIs. With these definitions, you can create sophisticated, autogenerated documentation, generate SDKs in several languages, and do automated testing. Swagger is a set of open source tools that use these Open API Specification definition files.
This course is for people in the software industry who are fairly technical, but are not software developers: for example, project managers, API product managers, and technical writers. It assumes that you understand REST and JSON, but that’s about all.
Time: 2.5 hours
Over 500 students enrolled
Coding for Writers 1: Basic Programming
Are you a writer who wants to learn how to code? There aren’t many people who can both code and write well, so if you can do both, you will find there many exciting, highly-paid opportunities in the technology industry. This course teaches basic programming to writers, combining learning about coding with learning to write about coding.
Time: 4 hours
Over 600 students enrolled