Skip to end of banner
Go to start of banner

Synapse Docs Style Guide

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

  • 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

  • Synapse buttons are emphasized as bold. e.g. “Click File Tools.”

  • 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.

    • 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

  • No labels