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

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.

icon
Quality Score

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

Overall Score : 86 / 100

icon
Course Description

Course DescriptionThis 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.
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.)

icon
Instructor Details

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.

icon
More courses by Peter Gruenbaum

Learn API Technical Writing 2: REST for Writers

$11.99

Learn Swagger and the Open API Specification

$11.99

Coding for Writers: Basic Programming

$11.99

Git and GitHub for Writers

$11.99

icon
More it & software courses

Kubernetes Certified Application Developer (CKAD) with Tests

$11.99

Angel Oracle Card Reader Course; Become the Oracle

$11.99

Cisco CCENT Packet Tracer Ultimate labs: ICND1 Exam prep lab

$11.99

Microsoft Access Networking 2: Maximum Security

$11.99

Oracle 12c Multitenant Architecture Administration

$11.99

Certified Kubernetes Administrator (CKA) with Practice Tests

$11.99

icon
Reviews

4.3

122 total reviews

5 star 4 star 3 star 2 star 1 star
% Complete
% Complete
% Complete
% Complete
% Complete

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/8/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/27/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!

By Faizan Hussain on 8/24/2020

Add some details, although it is a subjective course but there is something missing that is not catching the audience as it should be. For example, some more interesting software, project-specific API documentation, and others.

By Steve Schaefer on 8/3/2020

This is my third course in a few days! I'm getting a good idea of what to do and why it's important. This course especially puts the last two into perspective.

By Matt Danda on 7/20/2020

I acquired confidence that my current approach to documenting APIs follows the standards recommended by experts.