RSSAll Entries Tagged With: "documentation"

The Five Biggest API Documentation Mistakes and How to Avoid Them

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 [...]

| May 05, 2012 | Comments
Read More
Won’t reading about API documentation put me to sleep?

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. [...]

| Apr 13, 2012 | Comments
Read More