Thoughts on Style:
Discussion group recommendations
This page provides answers to questions on writing
style that often arise in the ISTC's online discussion groups, from where
many of the cited recommendations and sources are taken. It does not
prescribe particular practices but indicates the popularity of acceptable
alternatives and lists sources of more information. It covers:
Technical writers should comply with their
employers' or clients' style guides unless they are asked to review the
guidance or create a new style guide. If asked to give guidance on style,
they should consult up-to-date editions of reputable publications and
draw together the most appropriate modern practices for the audience and
sector. They should not cling to practices widely viewed as outdated
without good reason: readers' needs are more important than writers'
preferences. Of course, there is always a balance to be reached between
reflecting changing usage without perpetuating common errors.
You can use www.googlefight.com to find which of two options is more
widely used in material available through the Internet. However, the
results do not take into account regional differences and, of course, a
common usage may still be incorrect.
The ISTC provides access to Oxford Reference Online as a member benefit.
This gives guidance on many aspects of spelling, grammar, punctuation
and vocabulary.
The ISTC also provides British standards to its members at 15% below the British Standards Institution's member prices. The website lists some relevant standards for technical writers.
Note: Standards (both British and international) do not always agree with one another on particular practices, and the fact that a standard advocates a practice does not mean a conflicting practice is wrong. However, adopting a standard can provide a useful shortcut and enable an organisation to state that its documents conform to that standard.
The house style for the ISTC's quarterly journal, Communicator, demonstrates a minimalist approach to style guidance. It states preferred options for the discretionary practices that most often cause inconsistency between articles.
Back issues of Communicator are available to members in an archive on the website. Most contain a Hints for writers or Editing page. Feature articles on language include:
- Autumn 2006, Freeing your writing from bias
- Spring 2005, Wycliffe Associates' EasyEnglish
- Spring 2005, Taming the English Language
- Winter 2004, AECMA Simplified English
Several other sample style guides are listed for inspiration. |