Rev2: changes to the gsoc project completion wiki page about g2s HOT 1 CLOSED

Thanks Robert!

On Wed, Aug 17, 2016 at 7:38 PM, Robert Sheridan [email protected]
wrote:

Here are some suggested improvements and points of feedback:

• The title of the page doesn't need to say "wiki", since that is
  obvious because the page is found under the "wiki" tab. It also doesn't
  need to say pdb-annotation .. since visitors already know the project they
  are looking at. For a title, describe what this particular wiki page is
  meant to capture .. my suggestion: "gsoc 2016 project summary and guide"
• delete the welcome line (not helpful)
• Use better text formatting and indentation to make clear which parts
  of the instructions in section 2 (Installation Guide) are "commands for the
  user to type". If these are all in a distinctive font and have a standard
  indent it makes it much easier for the reader to know what they are
  supposed to type and where they are in the process.
• The instructions themselves in section 2 (Installation Guide) should
  be rewritten so that someone who knows nothing about the project
  will still be able to know what to do and how to get the program installed
  and running. Too many of these instructions assume the user knows the
  project and can figure out appropriate settings ... and some of the example
  file paths will probably need to be different depending on where the user
  chooses to install and run the code.
• the API Documentation Section "Functional Details" for the first API
  endpoint is not accurate. Rewrite this text so it describes what the API
  actually does
• the one main figure / diagram is good. Look for other opportunities
  to present helpful images which capture the purpose of document sections
  "at a glance" A figure for the API Documentation section might be helpful
  for example.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#38, or mute the
thread
https://github.com/notifications/unsubscribe-auth/ADL7zLs5saeWLLQ3U8vx871WwZC2BW2Jks5qg6mdgaJpZM4JnBjb
.

from g2s.