All Entries Tagged With: "api"
The Five Biggest API Documentation Mistakes and How to Avoid Them
Good API documentation can have a tremendous impact on whether a software platform is adopted. However, too often API documentation ends up being confusing and hard to follow, which results in developers choosing another way to accomplish their goals. This posting describes five common mistakes that are made in creating API documentation and describes solutions [...]
Won’t reading about API documentation put me to sleep?
I’m excited to join the Developer Think Tank Round Table! You’ll be getting posts from me about the art of API documentation. Wait — don’t leave just yet. If the thought of documentation makes your eyelids grow heavy, you are missing out on one of the most interesting (and important) parts of the software industry. [...]
The Social Contract
Allow an easement As developers, and really, as human beings, we all abide by certain social contracts. API providers and developers are often bound by more intense forms of these, by way of legal terms of service. Fundamentally, though, these are all that same basic social contract. There has been talk recently of a sort [...]
