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 »
Tag: API documentation
Content as an API – Mozilla Developer Network
Mozilla is an organisation that always seems to be doing innovative things with their documentation. One of the experimental functions it has introduced to its Kuma wiki platform for the Mozilla Developer Network (MDN) documentation is an experimental PUT API that makes it possible to create and update articles remotely. Mozilla suggests a number of ways it can be… Read more »