Posts Tagged: api documentation

Using Templates for Documentation Driven API Design

As an API provider it’s important to consider how consumers interact with your API. While most people leave this task to the very end, API design should, in fact, begin with clear and concise documentation. This practice is often called “Documentation Driven Design” or “Documentation Driven Development” and is followed by many practitioners around the world. Read more

How to Spark API Adoption With Good Documentation Practices

While almost everyone seems to agree that documentation is of key importance when launching an API, little is said about how it can actually affect API adoption. Jeffrey Hammond, a Principal Analyst at Forrester, claims that “adoption patterns are shifting towards developers,” giving them the power to “block or aid the adoption of software.” This means that a significant way to persuade decision makers to choose your software over your competitors’ is to gain the trust and confidence of developers. Read more