Acronyms are awful

Acronyms and initialisms are strings of capital letters without full stops used to shorten long organisation names or groups of words such as ABS for Australian Bureau of Statistics, NSW for New South Wales, or CPI for consumer price index. Acronyms are easy for the writer but hard for the reader, so try to avoid using them.

Acronyms save the writer from typing out long names and phrases in full and make the text look shorter. But a paragraph, page or document full of acronyms is hard for the reader, who may be less familiar with all the terms used, and over-use of acronyms can slow a reader down.

Tips

  • Use acronyms only for very well known organisation names or the author or publisher of the document
  • Write out as many acronyms as possible in full, especially if they are only used a few times
  • Include a glossary or list of acronyms at the front of the document if use is unavoidable
  • Use acronyms in tables where space is more limited, but include a note to explain the term.

These tips also apply to abbreviations and contractions. Make it easy for the reader.

Macquarie Dictionary – the authoritative source on Australian English

How do editors decide what is the Australian spelling for a word, or if a word is written as one word, two words or has a hyphen?

The Macquarie Dictionary is the authoritative source of information on spelling, hyphenation, capitalisation and common use in Australia. It is the reference on Australian English. The Appendices include a handy guide to punctuation (I’m brushing up on colons vs semicolons), as well as foreign phrases, signs and symbols, and more.

The Macquarie Dictionary Sixth Edition (2013) has a RRP of $99.95. Check online booksellers for a cheaper price including delivery. At over 1,700 pages, you’ll appreciate not carrying the hardback home. There are many versions of the dictionary available so check carefully before buying, especially online.

You can also subscribe to the Macquarie Dictionary Online at www.macquariedictionary.com.au. It is updated annually and with over 300,000 words and definitions, it can help you get your writing right. I haven’t tried it, but the audio pronunciations of 25,000 entries could be useful for some users.

Getting it right through fact checking

I’ve been reading The Fact Checker’s Bible: A Guide to Getting it Right by Sarah Harrison Smith, a former fact checker at The New Yorker, which is a great resource on the importance and process of fact checking. Getting facts right can prevent embarrassment, enhance credibility, save money by preventing lawsuits, and identify plagiarism.

The Fact Checker’s Bible discusses checking a wide range of facts including names, dates, biographical details, locations, descriptions, quotations, lyrics, maps and artwork – in fact, everything in a story or article.

The role of editors in fact checking work depends on the specific requirements of the job, and often the time and budget available. Editors may check all facts, some or none. Every fact can be checked or only the most controversial.

Tips for writers

  • Keep records of your sources and notes.
  • Try to check facts yourself.
  • Critically evaluate sources and check with experts.

Tips for editors

  • Be aware of facts that may need to be checked.
  • Ask the author for their sources and notes.
  • Ensure non-text material such as maps, photos and artwork is consistent with the text.
  • Check headings, headlines and captions where errors may be more visible than in the text.
  • Identify material which has not been checked.
  • Don’t assume someone else has checked it.

But what is right? A sobering line in the book is: “It is ironic that many of the best resources for fact checkers are not fact-checked to the standard to which checkers aspire”.

For more, see my April 2014 post on right and wrong in editing.

How to avoid a journal editor’s reject pile

Academic publisher Elsevier says that its journal editors reject between 30 and 50% of the articles submitted to Elsevier journals before they even reach the peer-review stage, and one of the top reasons for rejection is poor language. Journal editors make decisions at their desk before the paper even gets to reviewers.

Elsevier says journal editors don’t like:

  • sloppy copy
  • unclear messages
  • inconsistency and inaccuracy
  • unsuitability
  • unclear impact or novelty.

No surprises there!

Tips to avoid the reject pile

  • Take care as you write and type and ask someone else to read your paper.
  • Use short sentences and simple language to focus on your message.
  • Check once, check twice and check again.
  • Check your manuscript is within the scope of the journal.
  • Be clear about the findings, what’s new and the impact on the research field. But don’t overstate the impact.

See the article and more in the latest Authors’ Update from Elsevier at Authors’ Update.

Achieving consistency with multiple authors

A recent Society of Editors (NSW) meeting on 5 May highlighted the challenges in achieving consistency in multi-part documents written by many authors.

The use of house style guides and style sheets makes it easier to achieve consistency in style issues such as spelling, hyphenation, capitalisation, dates and numbers. A house style guide sets out the preferred style choices for an organisation’s publications. A style sheet is similar but is developed for a specific publication, with specific terms used in that publication often listed in alphabetical order for easy reference.

Tips for achieving consistency with multiple authors

  • Check if there is an existing house or organisation style guide.
  • Develop a simple style guide for common decisions.
  • Let all authors know about the style resources and how to use them.
  • Review and update the style resources regularly.

Editors also use style guides and sheets to ensure consistency in their editing decisions on multi-author works and to reduce the use of personal preference.

Useful starting points are the Style Manual for Authors, Editors and Printers (6th edition, 2002), discussed in a February 2014 post, and the Macquarie Dictionary for accepted Australian spelling, hyphenation and capitalisation.

But even the most comprehensive style guide won’t have the answer to every editing question. Editing choices should always reflect the purpose and audience of each document.

Footnotes – not a fan

Footnotes at the bottom of a page can be used to provide references or additional information such as an explanation or clarification.

I am not a fan of footnotes at the bottom of a page as they don’t contribute to clear communication. It is distracting for readers to leave the text, go to the bottom of the page to read a note usually in smaller font, then try to return to their place in the text. Then repeat several times on a page. And on the next page and the next.

When considering footnotes, ask yourself: How important is the information? If it is very important, worth saying and you want readers to read it, then put it in the text, not as a footnote. If it is not important, leave it out. This suggestion applies to both brief, infrequent footnotes and longer, more frequent footnotes.

For footnotes which are references, consider using the author date style for referencing in the text. If important explanatory notes are required, consider listing them either at the beginning of the document or at the end of the chapter or document.

Tips for top tables

Tables can supplement or summarise text and make your document easier to read and your message easier to follow. You may need to try a few different formats to see which one works best for your data and message.

Tips for designing tables

  • Use the right format, size and layout for the purpose.
  • Use a consistent format across multiple tables including titles, column and row headings, and notes.
  • Experiment with font size, vertical and horizontal lines, and white space.

Tips for labelling tables

  • Include a detailed title for the table.
  • Include explanatory notes for the source and date of the data, and for row and column headings.
  • Ensure the units of measurement for data are clear.

Tips for placing tables

  • Place tables after they are first mentioned in the text.
  • Place tables at the end of a paragraph, not in the middle of a paragraph.
  • Do not split a table over a page unless the table is unavoidably longer than a page.

Most of these tips also apply to fabulous figures. Take care that colours and shadings used in figures are distinct and legible.

Font size – is there a right size?

Someone asked me recently if there is a right font size to use for text. The right font size depends on the purpose and audience for a document. Arial or Times New Roman in 11 point is a good starting point for a clear, easy to read report. But 11 point won’t be right for everything.

A business card can use a small font size such as 8 or 9 point for some details, but a name badge the same size needs a larger font size to stand out. A letter or report may use a larger font size such as 11 or 12 point, while an eye-catching brochure or leaflet may use an even larger font size for text such as 14 or 18 point.

The choice of font size depends on the overall spacing and layout of the document such as

  • the page margins
  • the length of lines
  • the space between lines
  • the space between paragraphs
  • the size of headings
  • the choice of font.

All these elements affect the look and readability of your page. There are some guides about the preferred number of words or characters per line, but experiment to find what works best for your document and audience. You can adjust the font size for formatting purposes – to fit all the text on one page or to stretch it out to fill a page.

Writing with passion

Writing with passion

Recently, I was pleased to see a letter I wrote published in the Sydney Morning Herald. I wrote it with passion because the issue of the usefulness of the five yearly Census by the Australian Bureau of Statistics was important to me.

People recognise and respond to enthusiasm and passion, whether it is demonstrated in writing or in person in presentations. A fellow newspaper reader even looked up my phone number and phoned to agree with me and talk about the issue.

When writing with passion,

  • do a first draft quickly, then leave it and review it later to get the tone right
  • support your position with arguments and evidence
  • direct your enthusiasm and focus on your message
  • use the right language to convey your enthusiasm to your specific audience.

The who and how of acknowledgements

The acknowledgements section is the place to recognise and thank people who have contributed to your document. Who you recognise and the tone you use to express appreciation varies depending on the type of document. A thesis should always recognise supervisors, while a novel might thank agents and editors, and a government report might refer to other agencies.

Consider these contributors:

  • supervisors who provided academic or professional guidance
  • organisations who provided financial or in-kind support
  • individuals and organisations who provided helpful information, data or advice, or specific services
  • family and friends who provided personal support.

Consider these tips:

  • put the most important and significant contributions first
  • keep the tone consistent with the style of the document
  • keep the length in proportion with the document
  • convey a professional image.

Acknowledgements usually appear at the beginning of a document, but there is an increasing trend to place them, together with other preliminary pages, at the end of the document.

Spelling in Australia includes both acknowledgement (with a middle “e”) and acknowledgment. Remember to be consistent throughout.