Documentation

Using documentation to attract new API consumers can be an effective distribution tactic if done correctly. One way to attract new users to your API portal is by making your documentation easy to discover. You can use what is called search engine optimization, or SEO, to make sure search engines process and deliver the content you write as search results. The way to do it is to think about your documentation from the perspective of potential users searching for a solution to their problems. The higher your content shows on a search results page, the more chances you have of someone opening your portal and, from there, signing up to use your API. So, as an example, if you’re building a payments API, you’ll want to focus on writing tutorials explaining how to implement a payment solution. Instead of focusing your documentation effort on explaining what your API does, you show users how they can implement a solution to their job to be done.

The content needs...