Part 1 in API Series: Introduction to API Technical Writing


Sarah Maddox


February 11, 2015 - 2:00 PM


February 11, 2015 - 3:00 PM


9401 Lee Highway, Suite 300, Fairfax, VA 22030   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




+1 (703) 522-4114


Career Center

Find your next job/contract opportunity here! Look at the STC Job Bank and get 14-day advance access to the newest employment opportunities.


Access to our industry-leading publications: Intercom, Technical Communication journal, STC’s Notebook blog, newsletters, and the Body of Knowledge (TCBOK).


The educational opportunities that STC members gain access to offer a breadth of continuing education knowledge in a variety of formats including webinars, online courses, Summit sessions, and more.


Leverage the power of members from around the world. Build relationships, advance your career through STC’s global community of technical communicators.


Society for Technical Communication
Phone: +1 (703) 522-4114 | Fax: +1 (703) 522-2075
3251 Blenheim Boulevard | Suite 406 | Fairfax, Virginia 22030
Email: STC | Map it!


The Society for Technical Communication advances technical communication as the discipline of transforming complex information into usable content for products, processes, and services.