Web API documentation is a necessity for the success of a platform. Developers need docs to learn how to utilize your resources. Providing poor documentation is often considered worse than no documentation at all (which is inexcusable).
Why do so many companies fail at providing great docs? What are the trends in the API universe when it comes to web API docs?
Neil will discuss the trend of interactive API documentation, and how it helps platform providers maintain docs more easily, keep docs examples fresh and up to date, and provide an interactive learning environment that is clean and concise.
Whether you’re just rolling out a new project, or you’re maintaining ten years and three major versions of legacy code, good documentation is vital for your users. They won't bother downloading your software if they can’t work out what it does, and if all you have is the bare-bones documentation to help them to get up and running, you’ll end up spending more time than you want to on support.
25th–29th July 2011