Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Article content should begin with a short summary describing what the page is about.

  • Synapse entity types or features are only emphasized in the top-most Overview section on each page. e.g. File , Project

    In all subsequent sections, these entity types or features are

    referred to as proper nouns and capitalized. e.g. File, Project.

  • When writing instructions, Synapse buttons or other elements of the UI are emphasized as bold. e.g. “Click “Click the File Tools menu.”

  • Synapse ID should be abbreviated as synID, not synId.

  • Code formatting:

    • Use this to refer to specific synIDs, file names, file extensions, class names, or user inputs.

      • for example “To store Docker images, use the docker push command.

    • Do not use this to refer to elements of the UI.

  • Terms to avoid:

    • Please

    • easy/easily

    • simple/simply

    • latin abbreviations (etc, e.g., or i.e)

  • When in doubt, consult the Google Developer style Guide

...