I don't want to write much about documentation improvement suggestions
so I will post briefly what kind of improvements could be made in many
places.

People like specifics so just to pick one page at random:

http://code.google.com/appengine/docs/java/datastore/hr/

This page is pretty short so there is not a lot wrong with it but the
fact that a short page can have problems is remarkable enough for me
to comment on it.  There are some obvious problems.  I guess this
could be the end of this comment ............ but to make it more
obvious, there is some information repeated across the two sections,
those sections being the ones linked from the top:

    * Comparing the Data Storage Options
    * Selecting a Datastore

In this particular case, but certainly not all cases on all pages, the
repetition about the algorithm and costs might be better if cleaned
up.

In the second section there is information about how to select a radio
button and what to click.  If this type of information is needed, it
might be better to ensure that the prompts are better.  For example:
radio buttons should not be labeled simply A and B.  If the prompts
are good enough then it might be better not to write about them in the
documentation.

There is also a screen capture.  If the user will see it when the user
goes to use it, I am not sure what the value is to have a screen
capture especially if the screen is a simple one.

I know there must be opposition to fixing these problems otherwise
they would have already been fixed but there exists an interesting
equilibrium.

-- 
You received this message because you are subscribed to the Google Groups 
"Google App Engine" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/google-appengine?hl=en.

Reply via email to