There isn’t a great deal of research into API documentation, and the factors that make API content good or bad. Here’s some of the papers we’ve found so far: How API documentation fails. Research by Uddin and Robillard, McGill University, 2015. Creating and Evolving Developer Documentation: Understanding the Decisions of Open Source Contributors, Dagenais and Robillard, 2010…. Read more »
Category: API
Microsoft publishes its REST API Design Guidelines
Microsoft has published its REST API Design Guidelines to the API community. According to Gareth Jones, Principal API Architect, who announced its release: “The effort got started from hearing two key points of feedback from customers: It should be easier to get started with Microsoft APIs – Developers wanted to be able to run the curl tool… Read more »
API documentation design patterns
One of the current developments in technical communication is the development of a common way to present API documentation. At present, there are a number of different design patterns that organisations are using, but, as with many things, there seems to be a desire to establish a de facto standard. One part of this has… Read more »