Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • In section headings, use title case. That is, capitalize every word in the title except for minor words and prepositions.

  • Do not capitalize entities such as project, table, or file. While this may be occasionally used as a convention in developer docs, it is not common for user docs where the audience may be less technical.

Terminology

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

  • Avoid using the term “entity” when possible. Less technical audiences may not be familiar with this concept, so it may cause confusion.

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

Images

  • Screencaps Whenever possible, screencaps should be anonymized so that personal your Synapse usernames username or other personal identifiers are not visible.

  • Name the image with a short description of the component you are illustrating, separated by hyphens. For example, report-violation-footer.png to show a screencap of the link to report a violation in the footer of the Synapse web UI.

...

  • New features and improvements: use present tense for describing how the product currently works and behaves ("You can now..."). The fact that work was done is implied and not very interesting. Focus on value add and how Synapse is better/faster/easier to use/etc.

  • Bug fixes: use past tense when describing the issues that the release is solving ("The flux capacitor wasn't reacting to stimuli"). Avoid the term “bug” when describing a fix.