Documenting REST APIs

This course is for anyone responsible for managing, planning or writing API documentation

   Watch Promo

Primarily aimed at REST APIs, this will help you to document your API, and manage the API documentation process. This course is aimed mostly at people who are not developers, and no programming experience will be required.

The exercises are based around an API for topic everyone understands – a hospital.

To enrol: http://cherryleaf.teachable.com/courses/writelessons

Who is this course for?

This course is for anyone responsible for managing, planning or writing API documentation:
  • Technical communicators unfamiliar with APIs and API documentation
  • Developers unfamiliar with Information Design and technical writing best practices

Course outline

  • What is an API?
    • Types of APIs
    • Examples of APIs
    • How REST APIs work
  • Using an API
  • Where are APIs?
  • The audience for API documentation
    • What do they want?
    • Who uses API documentation
  • Writing API documentation
    • What content goes into an API document?
    • Common structures for API documents
    • Automatically generated content
    • Manually written content
    • Writing the content
    • Code samples
  • Design patterns in API documentation
    • Standards and emerging conventions
    • Designing the content to meet the audience’s needs
  • Authoring tools
    • Creating content
    • API Specification tools
    • Publishing the content
    • Managing the content
    • Automation tools
  • Managing an API documentation project
    • Mixing automatically generated content with hand crafted content
    • Editing and reviewing content
    • Maintaining the documentation and version control
    • Integrating it with your existing documentation workflow
    • Building a documentation team
    • Testing


No programming experience is required.

Professional certification

certified member logoIf you want to become a Junior, Certified Member or Certified Fellow of the technical communicators’ national professional body - the Institute of Scientific and Technical Communicators (ISTC) - Cherryleaf’s training courses can help. Junior Members, Members and Fellows are certified by the ISTC through a vetting process, with Members and Fellows entitled to use the initials MISTC or FISTC after their names. All ISTC members have a responsibility to maintain their professional competence through Continuing Professional Development (CPD) , and Cherryleaf’s courses can help demonstrate you are extending and updating your skills.

How to Enrol

This course is part of WriteLessons, from Cherryleaf

WriteLessons, from Cherryleaf, provides you with access to a range of courses in technical communication. You have access to all of the courses contained within WriteLessons, which you can take at your own pace.

To enrol: http://cherryleaf.teachable.com/courses/writelessons

Your Instructor


Cherryleaf is a technical writing services company formed in 2002 by people with a passion for technical communication and learning development.

Cherryleaf is recognised as a leader within the technical communication profession. Our staff have written articles for the Society for Technical Communication's (STC) Intercom magazine, the Institute of Scientific and Technical Communicator's Communicator journal and tekom's TCWorld magazine. They've also written books on technical communication. We've presented webinars for Adobe, Madcap Software or the STC, and we've spoken at various conferences around the world.

Today, organisations throughout Europe use Cherryleaf’s services so they can provide clear information that enables users and staff to complete tasks productively.

Courses Included with Purchase

Managing Software Documentation Projects
2 Course Bundle
Markdown - Friend or Foe
A presentation on the pros and cons of Markdown
Revising and Editing Content (Beta)
2 Course Bundle
Single Sourcing and Content Reuse
This online training course teaches the basic skills in single sourcing and writing content for reuse

n/a: $108

Frequently Asked Questions

When does the course start and finish?
It is a completely self-paced online course - you decide when you start and when you finish.
How long do I have access to the course?
After enrolling, you have access to this course for as long as you are a subscriber - across any and all devices you own.
What if I am unhappy with the course?
We would never want you to be unhappy! If you are unsatisfied with your purchase, contact us in the first 30 days and we will give you a full refund.

Get started now!