Preliminary matter

Title page

Keep the main title short, specific and informative, and ensure that it accurately reflects the content of the book or report.

On the title page, you can include the title, name of the author(s) or responsible organisation(s), and name of the publisher or publishing organisation. You might also wish to include a date of publication (or date of endorsement) on the title page.

The title page (and/or cover) may also include a logo for the organisation or business. Logos often have specific style requirements set by the organisation. For example, Australian Government publications must follow guidelines on the appropriate logo to use, and its size and placement.

Return to top

Reverse title page

On the reverse title page, include:

  • copyright declaration (who owns the copyright; eg Copyright © Biotext)
  • copyright statement (details about the circumstances under which the material can be used, and how the material should be attributed); this may include licence information

With the exception of any material protected by a trademark, any content provided by third parties, and where otherwise noted, all material presented in this publication is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International licence.

  • the International Standard Book Number (ISBN; a number used to uniquely identify a commercial book) or International Standard Serial Number (ISSN; a number used to uniquely identify a serial publication)
  • the preferred way to cite the report
The institute’s preference is that you attribute this publication (and any material sourced from it) using the following citation:
Institute for Clear Writing (2020). Reaching your audience: a guide to writing technical information for a general audience, Institute for Clear Writing, Melbourne.
  • date
  • contact information.

If appropriate, add a note about the editor, designer or printer:

Production by Biotext, Canberra

Editing and publication management by Biotext, Melbourne

Design by Biotext, Canberra

Return to top

Dedication

The author may wish to ‘dedicate’ the book to someone. This text is usually placed on the right-hand page directly after the reverse title page.

Return to top

Letter of transmittal

A letter of transmittal is like a cover letter that is included in the preliminary matter of some reports such as government annual reports or financial reports. It usually records what the report is for, why it is required, who it is being sent to and when it was completed.

Return to top

Foreword

A foreword (not a forward) is usually written by someone other than the author, and often includes their signature block. The foreword commends the document to readers, and usually comes immediately after the reverse title page.

Return to top

Acknowledgments

The acknowledgments text is a brief expression of appreciation to people and organisations (other than the authors) who contributed to the publication (eg friends and family, members of a review committee, professional editors).

In some books, the acknowledgments section is placed at the end, especially when the list of people to thank is long.

Return to top

Shortened forms

The list of shortened forms provides definitions and explanations of acronyms and other shortened forms used in the document (see Lists of shortened forms).

Return to top

Glossary

The glossary was traditionally placed at the start of a publication, but is often now put at the back so that the front is not cluttered and people are not discouraged into thinking ‘I need to know all this before I can read the book!’ Also, many other things (eg contents, foreword, preface, summary) must go at the front, so it is good to move to the back anything that can be moved. This helps the reader to get to the actual content.

Return to top

Table of contents

If writing in Microsoft Word or Google Docs, create a table of contents (TOC) automatically using heading levels in the text (ie by applying paragraph styles). Do not manually create or update the TOC.

The precise format for the TOC will depend on the style of the publication and your own preferences. In general:

  • include 2 or 3 levels of heading in the TOC
  • do not include the heading Contents in the TOC itself – make it a ‘silent’ heading (see the following box)
  • do not include subheadings that occur in the summary or appendixes – make these silent headings (see the following box)
  • call the TOC simply Contents – it is not necessary to make it into a longer heading of Table of contents.

Lists of tables and figures can be included after the table of contents. Use headings Tables and Figures.

Did you know?

To create silent headings in Microsoft Word

  1. Create a new heading style in Word that is based on the existing heading level, but give it another name (eg Heading 1a, Heading 2a).
  2. In the options for the TOC (References > Table of Contents > Custom Table of Contents > Options), make sure Build Table of Contents from: Styles is ticked, but delete any number that appears next to your modified heading styles. Note that these modified heading styles are not recognised as headings by assistive technologies, which may affect the accessibility of the document.

If required, include in the TOC lists of tables and figures (created automatically from styles used in the text). Another option is to place the lists of tables and figures at the end of the document, before the references.

Return to top

Preface

The preface is usually written by the author, explaining how the document came into being and why it was written, and providing other brief background information.

Return to top

Summary

Reports often start with a summary that gives an overview of the report. This may focus on the conclusions of the report, or it may briefly look at each section of the report in turn (eg background, methods, results, conclusions). Ensure that the summary accurately reflects the contents of the report and does not include information that is not in the full report.

Summaries should be as clear and engaging as possible, even for very technical reports. Audiences use the summary to decide whether they want to read all the content, and some users will read only the summary and not the rest of the report.

Use subheadings in the summary to make the information as navigable as possible. These subheadings are not usually included in the table of contents (ie use silent headings – see the tip box under Table of contents).

Summary means the same as executive summary, but many people prefer the longer version. It is acceptable to call the summary an executive summary if it is an overview of policy decisions made by a working group (or similar), rather than a summary of the full content of the report.

Return to top

User login

... or purchase now

An individual subscription is only A$60 per year

Group and student discounts may apply

Australian manual of scientific style Start communicating effectively

Purchase