API documentation: the undiscovered country

Recording from UAEurope 2017 conference.

With many software developers now spending their time developing APIs, there’s an increasing demand for API documentation writers.

It’s a fast changing field, with emerging information design patterns and authoring tools. It’s also different from end user documentation, and this means many Technical Communicators are uncertain if and how they should migrate to these roles.

  • what is an API and what is API documentation?
  • the role of an API documentation writer, and how it differs from mainstream Technical Author roles
  • the skills you need as a writer of API documentation
  • becoming an API documentation writer.

REST API documentation training course:

http://cherryleaf.teachable.com/p/documenting-rest-apis

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.