The Art of API Documentation

API Documentation 3: Teaches technical writers how to write API overview material, tutorials, etc.
3.9 (88 ratings)
Instead of using a simple lifetime average, Udemy calculates a
course's star rating by considering a number of different factors
such as the number of ratings, the age of ratings, and the
likelihood of fraudulent ratings.
445 students enrolled
$19
$25
24% off
Take This Course
  • Lectures 13
  • Length 1 hour
  • Skill Level Expert Level
  • Languages English
  • Includes Lifetime access
    30 day money back guarantee!
    Available on iOS and Android
    Certificate of Completion
Wishlisted Wishlist

How taking a course works

Discover

Find online courses made by experts from around the world.

Learn

Take your courses with you and learn anywhere, anytime.

Master

Learn and practice real-world skills and achieve your goals.

About This Course

Published 12/2015 English

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.

What are the requirements?

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

What am I going to get from this course?

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

What is the target audience?

  • 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 get with this course?

Not for you? No problem.
30 day money back guarantee.

Forever yours.
Lifetime access.

Learn on the go.
Desktop, iOS and Android.

Get rewarded.
Certificate of completion.

Curriculum

Section 1: Introduction
04:44

This lecture covers:

  • What are APIs and why are they important?
  • Why is API documentation important?
  • The difference between conceptual and reference material
  • What is in this course
Section 2: API Conceptual Material
03:57

This lecture covers:

  • Why is API conceptual material important?
  • A quick description of:
    • Overviews
    • Getting Started
    • Tutorials
    • Sample Code
05:14

This lecture covers:

  • Explaining "Why", not just "How"
  • Key Concepts
  • Workflow diagrams
  • Architecture diagrams
04:12

This lecture covers:

  • Why a Getting Started section is critical
  • What "Hello World" means
  • The structure of Getting Started sections
  • What should be in a Web API Getting Started section
  • What should be in a Platform API Getting Started section
03:02

This lecture covers:

  • The importance of tutorials
  • Identifying common tasks
  • The structure of tutorials
  • Screenshots
07:33

This lecture covers:

  • Why developers like sample code
  • Guidelines for good sample code
  • Web API vs. Platform API sample code
  • Link to an article on this subject
Section 3: Tools
07:58

This lecture covers:

  • Why tools for calling REST APIs are useful
  • GUI tools
  • Command-line tools (cURL)
5 pages

This lecture shows you how to install Postman, the GUI REST Chrome app, and then use it to make REST calls.

5 pages

This lecture how to install cURL, the command-line tool, and then use it to make REST calls.

Section 4: Where to Go From Here
07:26

This lesson covers:

  • How to break into the field of API documentation
  • What is an open source project?
  • GitHub
  • How to find an open source project to document
04:20

This lecture covers:

  • A summary of all previous lectures
  • Next steps
1 page

This lecture contains an outline that shows a suggested structure for API documentation.

Article

Get a discount on the first course in the next series, which is Coding for Writers: Basic Programming.

Students Who Viewed This Course Also Viewed

  • Loading
  • Loading
  • Loading

Instructor Biography

Peter Gruenbaum, President, SDK Bridge

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.

Ready to start learning?
Take This Course