If you want to attract developers to your platform, obviously great API documentation is important. But that’s really only one piece of the story. The reason clear docs are great is that they enable that first test of an API, the “hello world.” There are several ways to accelerate that process, as described in the five keys to a great API. Below you’ll find six ways to reduce that TTFHW, or time to first hello world.
Before developers read a single line of your docs, they want to know whether your API can solve their problem. What’s your elevator pitch and can you condense that into a dead simple web page?
We think APIs can charge developers when value is provided. That’s a good thing. An even better thing is letting developers have a taste of what your platform can do.
There are a lot of reasons you might want to manually provision every developer. If you can avoid it, automate this process. Don’t make them wait to try you out.
It may not be the only answer, but documentation is still an important way to get developers to hello world. Want to dig deeper into docs? Check out the six pillars of complete developer documentation or the results of a survey about what developers want from documentation.
Giving raw RESTful docs reaches the most developers, but if you can give language-specific examples, they’ll be able to get up to speed much faster.
Whether it’s a dashboard, a debugger or some sort of explorer, if you give developers a way to play with the API they can evaluate what you’re offering much faster than if they need to set up their development environment or download an SDK.
These are six of the ways to accelerate the TTFHW. What other methods have worked well for you?
For other tips, see what makes a great API.