chapter 1 scope and nature of technical writing

Technical
writing
WRITTEN BY JOHN MASON AND STAFF OF ACS DISTANCE EDUCATION
CONTENTS
CREDITS
5
CHAPTER 1 SCOPE AND NATURE OF TECHNICAL WRITING
6
What Is Involved?
6
Examples of Technical Writing
8
Becoming a Technical Writer
9
What Characterizes Good Technical Writing?
10
Where and How Technical Writing is Published
11
Structure
13
CHAPTER 2 PREPARING TO WRITE
14
Define the Task
14
Identify Expectations
14
Clarify Your Writing Goal
15
Establish a Time Plan
16
Technical Writing Procedures
17
The Role of Logic
17
Writing Content
18
Some Essential Writing Skills
18
Planning Your Writing
18
The Writing Process
19
A Writing Routine
20
Meeting Expectations
20
Collaborative Writing
22
A Writer’s Equipment
23
CHAPTER 3 RESEARCHING YOUR TOPIC
24
Reasons to Conduct Research
24
Library and Internet
25
Evaluate and Select Information
26
Plagiarism
27
CHAPTER 4 WAYS TO COMMUNICATE TECHNICAL INFORMATION
28
Tools for Communicating in Words
28
Tools for Communicating in Graphics
33
Illustrations and Captions
33
Technical Photography
35
Combining Graphics and Text
35
The Importance of Captions
36
Computer Tools and Software
38
CHAPTER 5 ACADEMIC & BUSINESS CONVENTIONS
42
Presentation of Assignments
42
Essays and Reports
43
Writing Research Papers and Journal Articles
45
CHAPTER 6 REFERENCING
47
Referencing Systems
47
Types of Referencing for Different Tasks
50
Procedures
50
Scientific Writing
50
Proposals
50
CHAPTER 7 EDITING
51
Why Edit?
51
Develop a Sharp Understanding of Ambiguity
52
Causes of Ambiguity
52
Meeting Deadlines
54
Be Concise
55
Use Grammar and Punctuation Properly
55
Writing with Clarity
55
Common Causes of Confusion
56
Types of Language
57
The Editing Process
59
CHAPTER 8 WRITING FOR DIFFERENT PURPOSES
61
The Audience
61
Legal Applications
62
Writing Submissions
64
Writing Research Reports
67
Writing Manuals/ Instructions/ Guidelines
69
APPENDIX
73
Distance Learning and Online Courses
73
E-books by John Mason and ACS Staff
74
Printed Books by John Mason
75
Useful Contacts
76
ACS Global Partners
76
Social Media
76
> BACK TO CONTENTS PAGE
CREDITS
© Copyright: John Mason
Written by
Written by John Mason Dip.Hort.Sc.
FIOH, FAIH, FPLA
& Staff of ACS Distance Education
Photos:
John Mason
Leonie Mason
Stephen Mason
Layout
Stephen Mason
The information in this book is derived
from a broad cross section of resources
(research, reference materials and
personal experience) from the authors
and editorial assistants in the academic
department of ACS Distance Education.
It is, to the best of our knowledge,
composed as an accurate representation
of what is accepted and appropriate
information about the subject, at the
time of publication.
P.O. Box 2092, Nerang MDC,
Queensland, Australia, 4211
[email protected]
www.acsbookshop.com
The authors fully recognise that
knowledge is continually changing,
and awareness in all areas of study
is constantly evolving. As such, we
encourage the reader to recognise
that nothing they read should ever
be considered to be set in stone.
They should always strive to broaden
their perspective and deepen their
understanding of a subject, and before
acting upon any information or advice,
should always seek to confirm the
currency of that information, and the
appropriateness to the situation in which
they find themselves.
P O Box 4171, Stourbridge, DY8 2WZ,
United Kingdom
[email protected]
www.acsebooks.com
As such, the publisher and author do not
accept any liability for actions taken by
the reader based upon their reading of
this book.
Editorial Assistants/Contributors:
Gavin Cole
Adriana Fraser
Tracey Jones
Published by
ACS Distance Education
ISBN: 978-0-9942948-1-4
PAGE 5
> BACK TO CONTENTS PAGE
CHAPTER 1 SCOPE AND NATURE
OF TECHNICAL WRITING
Technical writing is different to other forms of writing. Other writing
may be primarily designed to tell a story or, in a broad sense, to
entertain, inform, educate or communicate; technical writing is more
about documenting information as a reference i.e. information that is
designed to instruct, explain or direct in a clear and concise manner.
The purpose of technical writing can be as diverse as preparing
a document that can be used by the owners of a new machine or
device, through to a report or thesis that records the results of a
piece of academic research or to simplify more complex information.
What Is Involved?
■■ Reports - data and analysis reports;
You may think technical writing has to
be about technical or scientific subjects,
but that isn’t necessarily so. Technical
writing includes the writing of:
■■ Leaflets and brochures - simple
■■ Manuals - instruction manuals,
procedures manuals, process
manuals, user manuals,
policy manuals.
PAGE 6
scientific reports; summarisations
of larger reports that highlight and
summarise key points and elements.
instructions e.g. how to assemble
something; OH&S instructions, how
to use a product; how to operate a
machine etc.
> BACK TO CONTENTS PAGE
■■ Marketing material
■■ News bulletins
■■ Newspapers
■■ Newsletters
■■ Press releases
■■ Product packaging
■■ Product labels
■■ Product reviews
■■ Product user guidelines
Other technical writing may be found in
any of the following:
■■ Articles (e.g. magazine)
■■ Blogs
■■ Production processes
■■ Progress reports
■■ Procedures (e.g. staff or quality
manuals)
■■ Books
■■ Project reports
■■ Catalogues
■■ Proposals
■■ Conference presentations
■■ Reference guides
■■ Contracts
■■ Research papers
■■ Course notes & study guides
■■ Sales material
■■ Course curriculum documentation
■■ Scripts for film or radio
Eucalyptus cinerea
■■ Customer service text
■■ Training material
■■ Demonstrations
■■ User manuals
■■ Educational handouts
■■ Warning labels
■■ Frequently asked questions (FAQs)
■■ Websites
■■ Journals
■■ Work specifications
PAGE 7