An API Documentation Framework for Technical Communicators

Jordan Stanchev

API stands for Application Programming Interface. An interface is a software abstraction, which allows two software applications to communicate with each other seamlessly.

There are two roles you need to consider when you write documentation about an API:

  1. The role of the developer who created the API. This developer needs to provide information about the way the API is supposed to work; what requests can it receive and what responses does is provide.
  2. The role of the developer who uses the API. This developer needs to read through the API documentation to understand the ways to connect to the API, the requests that he or she can send to the API, and the responses that the API shall return for these requests.

Duration: 3 hour(s)

Date: Various

Cost: 250,00 + tax

About This course

WHAT YOU'LL LEARN

In this course, you will learn:

  • What is API and API documentation – explained in a way so that you can understand. No special programming knowledge is required!
  • Which are the steps you need to follow to prepare and provide documentation about your API – a small framework to make sure you have steps to follow while preparing the API documentation.
  • Hints about 2 popular tools you can use to test an API and generate API documentation automatically.
    In the interest of time, we provide an overview of tools, such as Postman and Swagger, but we are not going into details about using these tools – they are already well documented and there are many courses about using these tools.

Try it now, and see how easy it is to write API documentation, once you know the basic steps to follow!

HOW YOU'LL LEARN

This is a video, e-leanring course delivered in nine modules by an expert in API technical documentation.

COURSE OUTLINE

Lesson 1 – Introduction to API documentation
Lesson 2 – What is an API?
Lesson 3 – Benefits of using an API
Lesson 4 – How an API works
Lesson 5 – Who creates APIs and the API documentation?
Lesson 6 – What is API documentation?
Lesson 7 – Types of APIs
Lesson 8 – Who reads API documentation?
Lesson 9 – Real-world API documentation examples
Lesson 10 – API documentation – a framework for writing
Lesson 11 – API documentation structure
Lesson 12 – Step One: Accessing the API
Lesson 13 – Step Two: API responses
Lesson 14 – Step Three: Requests
Lesson 15 – Postman: a tool for using APIs
Lesson 16 – Swagger: tool for automated generation of API documentation
Lesson 17 – Course recap

WHO'S IT FOR

This e-learning course is an introduction for technical communicators who want to learn about  preparing and delivering high-quality API documentation. It is designed to help you learn about APIs, where they fit in to your technical communications plan, and where to start.

MEET THE COURSE LEADERS

Using the principles he teaches, Jordan Stanchev has built his career in the field of technical communications.

He applies practical experience collected through years of work in the IT industry as a Java developer, DITA XML technical writer, knowledge architect, project management professional (PMP), and user assistance development architect.
Jordan Stanchev is one of the founders of TEKOM Bulgaria, a passionate university lecturer, and a User Assistance Development Architect at a Fortune 100 company.

more courses

    Enquire with us today

    Please complete the enquiry form below and one of the Firehead team will be in touch shortly

    I have read and understand Firehead's privacy policy

    I would like to receive updates, offers and news from Firehead