User Tools

Site Tools


drafts:victron_manual_of_style

This is an old revision of the document!


Victron Manual of Style (MoS)

The Victron Manual of Style (MoS), is a set of evolving and aspirational standards for the writing and design of documents. Victron's MoS is relevant to all documents that we produce, be they in digital, paper or web format.

Acronyms

Start a document with the full name of the acronym and then the acronym in brackets. Use just the acronym after that. Example: Battery Management System (BMS) and thereafter use just BMS.

Language

Use US English, as opposed to UK English.

Numbers

The following example shows the decimal mark and the thousands separator usage for both currency and non-currency numbers.

1,234,567.89

Ref: http://en.wikipedia.org/wiki/Decimal_mark#Examples_of_use

Punctuation

Product Acronyms

Consider

  • Capitalisation,
  • Punctuation, and
  • Omission or inclusion of spaces or hyphenation.

List of words that are often written incorrectly:

  • VE.Direct
  • VE.Bus
  • VE.Can
  • CAN-bus
  • VictronConnect
  • VEConfigure
  • Color Control GX → CCGX
  • Venus GX → VGX
  • CCGX/VGX - Referred to collectively as the Venus-device.

Spelling

There are several areas in which British and American spelling are different. Use the American spelling.

Ref:http://www.oxforddictionaries.com/words/british-and-american-spelling

Style

If in doubt The Economist has one of the best style guides I know of: http://www.economist.com/styleguide/introduction

drafts/victron_manual_of_style.1548150132.txt.gz · Last modified: 2019-01-22 10:42 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki