Documentation feedback and suggestions

[Jen]

Hi all,

I'm a tech writer for code.google.com. I'm getting ready to do an
overhaul of all of the documentation for Google's Ajax APIs.

I already have some thoughts about what can be improved, but I hope
you will have some ideas as well and can help drive the future
direction of the documentation. So if you have a minute, can you
please tell me:

What do you like about the current documentation?
What do you hate about it?
What specific suggestions do you have for improving it?
What additional information do you wish the docs contained?
What specific tutorials would most help you?
Anything else?

If you could also give me an idea how long you've been developing with
the Ajax APIs, and which APIs you're using, that would help me put
your ideas in context so I make sure I target the info in the docs to
the right people.

Thanks in advance! I look forward to hearing your ideas.

Jen

[fbparis]

Hi,

A clear explanation for all non-200 return status would be nice.

Not concerning the doc itself but the api, when some rate limit
reached, a retry-on or retry-after header would be great to help dev
improve the way they use google apis.

[Jeremy Geerdes]

I would also include documentation on the accuracy property of
GlocalResult's. It seems to be the same as that used with the GMaps
GclientGeocoder, but confirmation of that would be very nice.

Jeremy R. Geerdes
Effective website design & development
Des Moines, IA

For more information or a project quote:
http://jgeerdes.home.mchsi.com
http://jgeerdes.blogspot.com
http://jgeerdes.wordpress.com
jgee...@mchsi.com

Unless otherwise noted, any price quotes contained within this
communication are given in US dollars.

If you're in the Des Moines, IA, area, check out Debra Heights
Wesleyan Church!

And check out my blog, Adventures in Web Development, at http://jgeerdes.blogspot.com
!

> --
>
> You received this message because you are subscribed to the Google
> Groups "Google AJAX APIs" group.
> To post to this group, send email to google-ajax...@googlegroups.com
> .
> To unsubscribe from this group, send email to google-ajax-searc...@googlegroups.com
> .
> For more options, visit this group at http://groups.google.com/group/google-ajax-search-api?hl=en
> .
>
>

[Jeremy Geerdes]

The search result limits should be exceedingly prominent.

Jeremy R. Geerdes
Effective website design & development
Des Moines, IA

For more information or a project quote:
http://jgeerdes.home.mchsi.com

jrge...@gmail.com

If you're in the Des Moines, IA, area, check out Debra Heights Wesleyan Church!

[Jeremy Geerdes]

Also, it would be really cool if you would document the heretofore undocumented third options argument for the google.search.SearchForm.

Jeremy R. Geerdes
Effective website design & development
Des Moines, IA

For more information or a project quote:
http://jgeerdes.home.mchsi.com
jrge...@gmail.com

If you're in the Des Moines, IA, area, check out Debra Heights Wesleyan Church!

On Nov 25, 2009, at 1:12 PM, Jen wrote:

[PF4AjaxSearch]

A clearer description of the hierarchy of the objects would help.
Let's say a small drawing that explains to a beginner like me what was
derived from what and so on.
I am a little bit confused here, I am a beginner and I would really
like to read a short document that describes the evolution of the
custom search controls widgets and forms
and what is based on what and what lies at the bottom of each of these
older or newer pieces of code.
I am confused because I have seed old names like "GSomething..." and
the new "google.something..." all over the internet and for a beginner
looking for examples it is really confusing

Thank you
PF