Page Comparison

...

• Synapse 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 the File Tools menu”.

• Code formatting:

  • Use this to refer to specific synIDs, file names, file extensions, class names, actual code, or user inputs. Do not use this to refer to elements of the UI, as it is too distracting.

    • Good: “To store Docker images, use the docker push command.”

    • Avoid: “To store Docker images, use the docker push command.”

Capitalization

In section headings, use title case. That is, capitalize every word in the title except for minor words and prepositions. Always capitalize the first word of a section heading.

In document titles and headings, use sentence case. That is, capitalize only the first word in the title, the first word in a subheading after a colon, and any proper nouns or other terms that are always capitalized a certain way.Even though you're using sentence case, don't put a period at the end of a title or heading.

Terms

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

• Terms to avoid in technical writing:

  • Please - wordy and usually unnecessary in instructions

  • Easy/easily - it might be easy for you, but not to someone else

  • Simple/simply - it might be simple for you, but not for someone else

  • Latin abbreviations (etc, e.g., or i.e) - these reduce readability of an article, especially for non-native English speakers

...