Part 1 in API Series: Introduction to API Technical Writing

Speakers

Sarah Maddox
Presenter

Start

February 11, 2015 - 2:00 PM

End

February 11, 2015 - 3:00 PM

Address

9401 Lee Highway, Suite 300, Fairfax, VA 22031   View map

Applications use APIs to exchange information and services. You could say that APIs are the communication channel of the online world. Developers need help hooking their app up to someone else’s API. A writer who can provide that help is in a very good position.

Documenting APIs is not so very different from other types of technical writing. We show people how to use a product or perform a task. The difference lies in the product itself and the technical skills required. This webinar will introduce the role of API technical writer, the product (APIs), and the documentation. It will also provide ideas and links for continuing your own research after the session.

Topics to be covered include:

  • Introduction to the role of API technical writer
  • Overview of the types of developer products we may be asked to document
  • What an API is and who uses it
  • A couple of live demos of APIs that you can play with at home
  • Types of APIs, including REST APIs, other web services, library-based APIs like JavaScript, and more
  • Examples of good API documentation
  • The components of API documentation, and the technical writer’s role in the creation of each component
  • Tips on getting started as an API technical writer

MORE DETAIL

Website

www.stc.org

Phone

+1 (703) 522-4114

Email

education@stc.org