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
elearning

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 an API developer portal. You’ll gain confidence you’re approaching each writing project in the right way, and creating content that follows best practice.

Preview a module from the course

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 practices in API documentation and developer portals
  • Technical Authors wanting to understand APIs and how to write documentation for them.

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.

We also show examples of developer portals from the DevPortal awards, Google, Microsoft, and others.

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.

You will learn:

What is an API?

  • Types of APIs
  • Examples of APIs
  • How REST and other APIs work

Using an API

  • Authentication and accreditation

The audience for API documentation

  • What do they want?
  • Who uses API documentation?

What documentation should I write?

  • What content goes into an API document?
  • The twelve types of documents for developers that Google recommends
  • Common structures for developer portals
  • Automatically generated content
  • Manually written content
  • Writing the content
  • Code samples
  • Onboarding

Design patterns in developer portals

  • Standards and conventions
  • Designing the content to meet the audience’s needs

Authoring tools

  • Creating content
  • API Specification tools
  • Automation tools

Managing an API documentation project

  • Mixing automatically generated content with hand crafted content
  • Editing and reviewing content
  • Building a documentation team

Onsite courses

We can also offer it as a one or two day virtual classroom course (delivered over Microsoft Teams), 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.