New Release Icon

MadCap Flare 2021 r2 Introduces Major New Features for Learning & Development Programs and eLearning Content

Learn More

White paperThe Definitive Guide to Creating API Documentation

White paper Single Sourcing and Localization illustration

Technical Communication Best Practices for API Documentation

APIs are the building blocks of code used by developers to build applications. Many principles that apply to technical writing for other products apply to documentation APIs. However, there are some major differences that often elude technical writers moving to this area of technical writing

Download our free white paper, The Definitive Guide to Creating API Documentation, for tips on how to write and develop clear API documentation. In this guide, you will learn best practices when creating well-documented APIs including:

  • Standard templates or outlines for organizing reference pages
  • Writing styles for documentation
  • Formatting for API components and error messages
  • Where and when to include working code snippets for methods, functions and resources.