Post Profile






Why Your API Documentation Shouldn't Rely on a Tool

Algolia’s Maxime is often asked what tool the company uses for API documentation. He gives the name but he’s tempted to say it’s not an important question. What matters more than the software rendering your docs is the quality of the content. A good readme.md in GitHut is going to be more useful than nicely rendered docs that make no sense.
read more

share

Related Posts


10 Questions Your API Documentation Must Address

Technology / Internet : ProgrammableWeb

The success or failure of an API often lies with its documentation. A poorly documented API that offers few answers and gives little support to the developers you wish to use it will eventually send them searching for support, and A...

Why Writing Quality API Documentation Matters

Technology / Internet : ProgrammableWeb

In a recent blog post, software developer/entrepreneur Ruben Vermeersch discussed the importance of documentation when supplying APIs to third parties. Although this seems obvious, he notes that few developers enjoy the tedium of wr...

Twitter and LinkedIn Manage Tasks With Asana, New API Means Robots Can Too

Technology : TechCrunch: Enterprise

What could be a better endorsement of your product's quality than having some of the hottest companies in tech relying on it? Launched in November, task management software Asana is already being used by Twitter, Uber, Foursquare, L...

Hail Me an API!: YourTaximeter Estimates Fares in the UK

Technology / Internet : ProgrammableWeb

How much will it cost to hire that cabbie? The Yourtaximeter API gives access to such precise data that cab companies in the UK rely on it to give quotes. Yourtaximeter provides a tool anyone can use to calculate a fare. The API doc...

How to Properly Import Microsoft Word Documents into WordPress

Technology : Make Tech Easier

Microsoft Word is not the best tool to produce web-friendly documents due to the messy HTML it produces, and this is also the case with Google Docs and other Word Processing software. Despite this, many people prefer to use it when ...

Comments


Copyright © 2016 Regator, LLC