The Art of API Documentation (Udemy.com)
API Documentation 3: Teaches technical writers how to write API overview material, tutorials, etc.
Created by: Peter Gruenbaum
Produced in 2021
What you will learn
- Write API conceptual documentation, such as overviews, getting started sections, and tutorials.
- Make calls to REST APIs using visual and command-line tools.
- Find an open source project to document as a way of gaining experience.
Quality Score
Overall Score : 86 / 100
Course Description
This course teaches how to write conceptual 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 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.
What is Conceptual Material?
API documentation consists of reference material and conceptual material. Reference material describes the details of the API: what are the pieces of each request and response, or each class and member. Conceptual material orients developers so that it's easy for them to get started with a new API. What is in This Course?
By the end of the course, you will understand how to write good API conceptual material, how to make REST calls using GUI and command-line tools, and how to find an open source project to document. In this course you'll find:
8 videos that:
Describe how to write good conceptual material
Provide guidelines for good sample code
Demonstrates how to use tools to make REST calls
Leads you through examples of how to find open source projects on the internet
2 hands-on exercises to lead you through making REST requests using tools
PowerPoint presentations as a resource for every video lecture
A PDF with resources for finding open source projects
The course takes approximately 1 hours and 30 minutes to complete, depending on how fast you are with the exercises.
Who this course is for:
This course is designed for technical writers who have some understanding of how to write API reference material.
No programming knowledge is required.
Take the first two courses in the series if you need a stronger understanding of APIs.
This course does not cover how to document reference material (requests, responses, classes, members, etc.)
Instructor Details
- 4.3 Rating
122 Reviews
Peter Gruenbaum
Peter founded SDK Bridge to bring together his love of technology and writing. After 10 years as a software developer, he learned the skill of API writing at Microsoft. Since then, he has worked as an API writer to describe APIs for eCommerce, automobile traffic prediction, electric utilities, mobile phones, and tractors, just to name a few. In addition to API and SDK documentation, he creates video tutorials for software developer audiences. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.
More courses by Peter Gruenbaum
Learn API Technical Writing 2: REST for Writers (2021)
4.7 (308 Reviews)
Provider: Udemy
Time: 1.5h
$11.99
Learn Swagger and the Open API Specification (2021)
4.3 (219 Reviews)
Provider: Udemy
Time: 1 hour on-demand videoh
$11.99
More it & software courses
Kubernetes Certified Application Developer (CKAD) with Tests (2021)
4.9 (312 Reviews)
Provider: Udemy
Time: 9.5h
$11.99
Angel Oracle Card Reader Course; Become the Oracle (2021)
4.9 (288 Reviews)
Provider: Udemy
Time: 3.5h
$11.99
Cisco CCENT Packet Tracer Ultimate labs: ICND1 Exam prep lab (2021)
4.9 (121 Reviews)
Provider: Udemy
Time: 14h
$11.99
Microsoft Access Networking 2: Maximum Security (2021)
4.9 (68 Reviews)
Provider: Udemy
Time: 2.5h
$11.99
Oracle 12c Multitenant Architecture Administration (2021)
4.9 (53 Reviews)
Provider: Udemy
Time: 10.5h
$11.99
Certified Kubernetes Administrator (CKA) with Practice Tests (2021)
4.8 (312 Reviews)
Provider: Udemy
Time: 18h
$11.99












