Peter Hilton - Speaking & training

Flat HTTP API Documentation

Because flat design isn’t only for the user interface

The way we write API docs is highly structured, natural to programmers, and wrong. HTTP API documentation typically looks nothing like the requests and responses it describes. This creates extra work for the reader to understand the documentation structure, and figure out how to translate that to code. Instead, you need more readable documentation that doesn’t waste your time.

This presentation introduces Conversational HTTP API Documentation (CHAD) - a better way to write document your HTTP API. CHAD leverages HTTP’s own structure together with some layout and typography to document API/ by example, in as much detail as you like. Attendees will learn to see API documentation in a new way, which they can use immediately to write more effective documentation with less effort.

Share on TwitterShare on LinkedInShare on Google+
comments powered by Disqus