Writing API documentation training course

This is part of our intermediate/advanced technical communication training course

Cherryleaf's intermediate/advanced technical communication skills course provides you with access to a collection of online training modules, under a low cost monthly subscription plan.Go to our elearning platform

An affordable way to master the skills of API documentation writing

Cherryleaf’s popular online training course teaches you how the keys skills of writing and managing documentation for REST APIs. You’ll gain confidence you’re approaching each writing project in the right way, and creating content that follows best practice.

Who is this course for?

This course is for anyone responsible for managing, planning or writing API documentation. For example:

  • Developers wanting to provide API documentation that is complete and meets the needs of the users.
  • Developers wanting to discover best practice in API documentation
  • Technical Authors wanting to understand APIs and how to write documentation for them.
  • Developers wanting to learn the fundamentals of writing technical information in an clear and effective way.

Recommended by the ASTC

Logo for Australian Society for Technical Communication techcommnz logoThis course is recommended by The Australian Society for Technical Communication and The Technical Communicators Association of New Zealand to their members.

About the course

The course modules are delivered over the Web in small, manageable video presentations. The course handouts and exercises are downloadable as Word or PDF files.

With the time needed to complete the exercises, each delegate will need to allocate around two days to complete the course. You can go at a pace that suits you. You can pause the videos at any time and return to the course at times that are best for you.

Course outline

We use publicly accessible APIs, as part of this course.

No programming experience is required.

There are a few free applications that you’ll be using, which you’ll need to install these before you start the course.

The exercises are based around an API for a topic that’s easy for people to understand: a hospital.

You will learn:

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

Onsite courses

This course began as a classroom course (for the Government Digital Service). This means we can also offer it as a one day classroom course, if you have a team needing these skills.

Contact us

contact cherryleafUse our training services contact form to tell us more.

If you can’t see the course you want, we may still be able to meet your needs.