We believe that one of the hallmarks of a great development platform is its documentation. Developers should not only be greeted with enough documentation to be successful, but with a structure that makes finding the help developers are looking for as intuitive as possible.
The challenge many platforms face however is twofold. First, the platform and products being documented grow, and evolve. Then, as the underlying platform changes, documentation is forced to grow organically to accommodate the features and architecture the original documentation structure never anticipated. The end result? Documentation that is at best not organized intuitively for those not already familiar with the product.
The OpenTok platform has been on a similar journey. Our platform started as OpenTok 1.0 and was firmly rooted in Adobe Flash technology. Then WebRTC broke onto the scene, and we immediately began working to develop the next generation of our platform to support it.
Now, almost one year later OpenTok 2.0 is the leading WebRTC development platform. Accordingly, we wanted to pause for a moment, take stock of the vast amounts of documentation we have added in the last year, and ensure it was complete, easy to understand and easy for all of our developers to find: both our existing developer base, and the many new developers coming to our platform everyday.
Our process of improving our documentation is forever ongoing, but our most recent release has sought to make great strides in our documentation, including:
- Refreshing the design of the documentation, with a keen eye to improving readability.
- Adding a number of new tutorials, with special attention paid to expanding our list of resources for OpenTok 2.0.
- Separating our OpenTok 1.0 and OpenTok 2.0 documentation to better help our users understand the differences between the two versions of the platform.
- Expanding our list of support resources for developers, including new diagnostic tools to help developers troubleshoot connectivity and other issues.
We encourage everyone to take a look at the “new” documentation to share with us what you think!