At Box, we strive to deliver best-in-class API documentation to make it as easy as possible for developers to learn about our APIs.
One of the most important parts of any developer’s journey with a new API is exploring the documentation to understand how the API can be used. Unfortunately, a lot of companies struggle to create and maintain documentation and it is often treated as an afterthought. At Box, we invest a lot of time and resources in our making our documentation as comprehensive as possible, but we don't always have the context and perspective on the job for which a developer is looking to use our APIs. Box helps millions of users collaborate on their content every day using the Box apps and we're bringing that same power to our documentation.
Starting today, developers can suggest changes and additions to the Box API documentation. These changes, similar to a Github pull request, will then be reviewed and approved by the Box Developer Relations team. Once the changes have been approved, they’ll be published to our live documentation. Not only will this improve the documentation, but it will help us better understand what's important to our developer community and prioritize our internal efforts as well.
Check out this video to learn more: