Tuesday, June 07, 2011
+1'ing our API docs
By Ashleigh Rentz, API Docs Program Manager
"Hey Scott, how do I format this API call so the data comes back as a string instead of an object?"
Sometimes it’s hard to find the right doc at the right time. Lots of web pages mention the terms you’re looking for, but which ones actually have them in the right context? We ask our friends and coworkers these questions because we bet they’ve seen the problem before. We trust their technical judgment and we know they can skip straight to the right answer.
That’s why we’ve just added the +1 button to the top of most code.google.com API docs:
Whenever you find the key information you need, we hope you’ll +1 that page and let the world know! It’s a simple way to help point the people you code with in the right direction and make RTFM’ing a bit easier for everyone.
Ashleigh Rentz is a Program Manager supporting the team of technical writers who tirelessly document Google’s developer APIs. She can often be seen skating down the halls between meetings.
Posted by Scott Knaster, Editor