Contribute Media
A thank you to everyone who makes this possible: Read More

So You Need to Document an API?


Allison Moore Documenting an API can be an intimidating process: How should you organize the documentation? How should you present the endpoint reference? What sorts of conceptual information are developers be looking for? Where to start? This talk provides the answers to these questions! We’ll go through organizational strategies for API docs and discuss ways to handle the reference, tutorial, and conceptual material you might need to produce. Throughout, we’ll focus on thinking about what the end users need and building the docs to support those goals. We’ll also look at modern tools that can make your API documentation useful, usable, and snazzy-looking, and talk about strategies for documenting APIs when you’re stuck with a publishing tool that might not be ideal for the task (Madcap Flare, for example).


Improve this page