Skip to content
Write a review
UdemyIT & SoftwarePaid courseExpert levelCertificate

The Art of API Documentation (Udemy.com)

API Documentation 3: Teaches technical writers how to write API overview material, tutorials, etc.

4.5
2,505 reviews

Created by: Peter Gruenbaum

Last updated May 2021

Our take

Based on the ratings of 2,505 students, a sample of their written reviews and the syllabus, as the course stood in May 2021. No course pays to be reviewed.

This is the third course in Peter Gruenbaum's API writing series, and it only makes sense in that context. It covers the conceptual side of API docs: overviews, getting started pages and tutorials, plus guidelines for good sample code. It also has short lessons on making REST calls with graphical and command-line tools, and on finding an open source project to document for practice. The syllabus shows 14 lectures and about 59 minutes of video in four sections. It does not teach reference documentation, so the audience is writers who already know requests and responses.

Reviewers are mostly happy. Of about 2,500 ratings, 1,146 are five stars and 937 are four. Students call Gruenbaum clear and well prepared, and several say the tips and the links back to the earlier courses helped. One reviewer says they got a job within a week of starting the series, using a portfolio built from the lessons. The complaints are about size. Low-star reviewers say it is thin, and one says the platform API material felt like an afterthought. Another had trouble with code copied from the PDF, which came out with spaces between letters.

The last update was May 2021, so the tool demos may have aged, though a 2023 reviewer says the advice still holds up. There are no quizzes, just two hands-on exercises. For a short course it does what it says. Take it as the finishing piece after the REST and JSON courses, not on its own. Readers who want deep coverage should look elsewhere.

Best forTechnical writers who finished the first two courses in the series and now want to write overviews and tutorials.
Skip it ifYou want depth, SDK documentation, or a first introduction to APIs. This is short and assumes the basics.

Pros

  • Gruenbaum is described as clear, prepared and to the point, with useful writing tips
  • Links back to the two earlier courses, so concepts build on each other
  • Covers sample code guidelines and REST calls with GUI and command-line tools
  • Shows how to find an open source project to document for portfolio experience

Cons

  • Only about an hour of video, and several low-star reviewers call it too thin
  • Platform and SDK documentation get little attention
  • Last updated in 2021, and code copied from the PDF reportedly came out garbled
The course is excellent. I paid thousands to go to a coding school in Toronto and I’ve learnt more relevant information (as a Technical Writer) from Peters courses than I did at said school.
Chantel Trivett, a student

Labeled expert, but really for writers who know reference docs already. No programming is needed.

icon
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.

Course content

4 sections · 14 lectures · 59 min of video 2 articles

  1. 1Introduction 1 free preview1 lecture · 5 min
  2. 2API Conceptual Material 2 free previews6 lectures · 24 min
  3. 3Tools3 lectures · 8 min
  4. 4Where to Go From Here4 lectures · 12 min

Who it is for

The instructor says it suits

  • 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.)

What you need before you start

  • You should be familiar with APIs and how to document requests and responses (for web APIs) and classes and members (for platform APIs).
  • Google Chrome is required for one of the exercises.

How it compares

Against the other 1,182 rated Udemy courses in IT & Software on CourseDuck:

  • Rating4.5 out of 5higher than 45% of them
  • Reviews2,505#207 of 1,183 by number of reviews
  • Length1 hourshorter than 96% of them
  • Last updatedMay 2021earlier than 80% of them

icon
Course Description

Course Description

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 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.
Read More Expert Expert Level product length iconTime: 1h

icon
Udemy Discount

The discount is applied through our link. Open the course from here and Udemy's current promotional price is applied at checkout on most courses, no code to type.

Get the Udemy discount

Some courses are excluded from Udemy's promotions. If the price does not drop, clear your browser cookies and use the button again.

icon
Instructor Details

Peter Gruenbaum

Peter founded SDK Bridge to bring together his love of technology and writing. After getting a PhD in solar energy research, he spent 10 years as a software developer and writer. 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.  He currently works for Calibrant Energy, building software to control solar and wind farms with batteries. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University. 

Read More

icon
More courses by Peter Gruenbaum

$17.99

$11.99

$13.99

$10.99

$12.99

$19.99

All courses by Peter Gruenbaum

icon
More IT & Software courses

$49.99

$10.99

$124.99

$19.99

$11.99

$19.99

All IT & Software courses

icon
Reviews

4.5

2,505 ratings on Udemy

Select a bar to show only those reviews.Select the bar again to show every rating.

Write a review

By Devon Clasen on 11/30/2022

This is the third course I've taken with this teacher, and I'd say he certainly demystified a lot of API documentation for me. I took these courses over a couple weeks and I feel I need to retake them to really gel the information, as this content is new to me and was fairly challenging. I appreciate that, with all 3 courses, the teacher provided both theory and practical applications. The quizzes and exercises definitely helped reinforce the material, as many of us learn by doing. I've watched so many videos of developers (attempting to) explain api but none of them really made it as digestible and simple as these Udemy courses - and for an amazing price. I definitely recommend these API courses. Super helpful and yet inexpensive!

By Leslie Amadi on 11/4/2022

He's an awesome teacher!! I highly recommend! THANK YOU SO MUCH PETER GRUENBAUM I Started learning API from beginner level step by step, with zero knowledge on the the 29th of October 2022! With the knowledge I have gained from this course. Course 1 to Course 3. I got a job today the 4th of November! barely a week, with the API Portfolio I built from this lectures.

By Ati_mousavinia@Yahoo.Com on 7/21/2021

Hello everyone, I would like to share my experience with you regarding the third course which I have taken since last week in Udemy with Peter Gruenbaum. I highly recommend it to those who really need to know how to write and design API Documentation. In all three courses, I have found very informative and useful information which can lead you through all theories that you might read before. Furthermore, there are some exercises to check whether you have learned the topic or not. In this course, I have not felt a minute that the class is online as every topic was explained clearly and precisely. Before taking this course, I submerged in a lot of theories and explanations about API but no one actually said what that is and what is for but in this course you will get the hang of it. So don't miss your chance.

By Emily Rosales on 11/22/2020

A very clear and focused description of what API documentation is (as opposed to other forms of technical writing). It answers a lot of my questions about the subject.

By Oscar Rivera on 11/1/2020

This is the third course created by Peter that I completed. The only suggestion I would make is that perhaps just like he created a specific website to practice REST, for example, it would be a good idea to create a "mock" open source project so that people can document it and later compare it to a version developed by him. I wish the course was a bit longer! In any case, concepts from the previous course are starting to fall into place for me.

By Debojyoti Dey on 10/27/2020

good

By Darko Maljic on 10/6/2020

Very short and clear explanations for busy people to catch everything necessary

By Cass Hall on 9/29/2020

I really like Peter Gruenbaum's series about API documentation. Although I am an experienced technical writer, I am a rank beginner when it comes to API documentation. I've learned a lot and plan to take the entire series. Mr. Gruenbaum explains things clearly and at a good pace. He is prepared for his lectures, and he has obviously practiced what he is presenting. (I took a class from a competing organization where the lecturer was so ill-prepared that I just abandoned the course.) As a writer, I appreciate that he 1) briefly tells you what a section covers, 2) goes into detail about the information, and 3) reviews the points a section covered. (That method helps the information sink into your mind.) I also love that all of the class materials are available for download.

By Emily Schaedle on 9/24/2020

A great overview of documenting API with how to get started documenting API and REST to build a portfolio and resume if you are breaking into the field. Great tools to try and use for more resume strength! This is the third of his series. I highly recommended to go in the order as he builds upon the key topics you learned.

By Anonymized User on 9/8/2020

This course is awesome. Best suited for writers with a very non-techie background. Thanks a lot Peter.

By Priyanka Upadhyay on 9/4/2020

To the point!

By Renise Black on 9/4/2020

Quick and simple overview for experienced Technical Writers. I am looking to get into API Technical Writing and these two course really give me a big jump start, especially given my IT background. Thanks!

Showing 12 of 127 reviews

icon
Quality Score

No CourseDuck member has rated this course yet. Taken it? Give each part a thumbs up or down.

Content Quality
/
Video Quality
/
Qualified Instructor
/
Course Pace
/
Course Depth & Coverage
/

Overall Score : 90 / 100

The Art of API Documentation
Visit course on Udemy Write a review
  • Video Duration: icon 1h
  • Price: See price on Udemy
  • Provider: icon Udemy
  • Updated: icon May 2021
  • Level: Expert Expert
  • Language: icon English
  • Certificate: icon Yes
  • Lectures:14 in 4 sections
  • Students:12,400
  • Subtitles:2 languages
30-day money-back guarantee on most paid courses

Udemy Coupon Price Tracker

Udemy price history

For any issues or feature requests please email CourseDuck's Co-Founder at mkuhlman12@gmail.com