Technical writing
Learn the key features of technical writing for science and engineering
As a student engineer or scientist, you will be required to write technical reports as part of your program and throughout your career
These might include annual environmental reports to regulators, annual reports for shareholders, project proposals, tender documents and journal articles. This guide will explain the technical writing features and conventions used by scientists and engineers.Ìý
Looking for personalised help?
If you're looking for one-to-one support with your writing, book a consultation with an Academic Learning Facilitator.Ìý
-
Aim to inform
Scientific or technical writing for science and engineering is different from literary writing in a number of ways. Primarily, technical writing aims to inform rather than entertain and should be simple and concise.
- An example of a literary sentence: The wind was blowing fiercely and the air outside was growing chilled.Ìý
- An example of a scientific sentence: Onshore winds travelling at 45km per hour brought temperatures down to 15 degrees Celsius.Ìý
Your primary aim as a scientific writer should be to inform your audience. Avoid using emotive language and strive to transmit your information as objectively as possible.Ìý
Be concise
Don't use too many long sentences. Sentences with four or more clauses (or parts) are confusing to read. In most cases, two shorter sentences is better than one long sentence. However, a long sentence may be appropriate if you want to include a qualification or example.Ìý
- An example of a long sentence: After consulting three manufacturers: Dribble Co., Sooky Ltd. and Bungle Pty, we have found that there are two types of vibration suppression devices for portable CD players and both are simple in design but have inherent drawbacks.Ìý
- More concise: Three manufacturers were consulted: Dribble Co., Sooky Ltd. and Bungle Pty. We found two types of vibration suppression devices for portable CD players. Both are simple in design but have inherent drawbacks.Ìý
Use words economically. If you can use one word instead of two or three, choose one word. For example, write 'avoid' instead of 'get around'.Ìý
Be clear
Avoid being ambiguous. This can happen when you do not specify what you are writing about. It can even depend on the way you use words like 'it', 'this', 'thing', 'way' and 'some'.Ìý
- An example of unclear expression: The way we did the experiment was not so successful. Some of what we needed wasn't there.
- An example of clear expression: We were unable to complete the experiment. The glass tubing and tripods required for the experiment were not located in laboratory G025.
Do not use contractions of verbs and pronouns (such as 'doesn't', 'can't', 'it's' and 'they're'). Formal writing at university and in the workplace will require the full form of words ('does not', 'cannot', 'it is' and 'they are').Ìý
Be correct
Check the spelling, punctuation and grammar of your sentences. Easily-corrected errors in your written work will negatively affect your presentation and grades. You may identify your errors more easily if you wait a day or two after you finish your writing to proofread. This is called 'the drawer treatment'.
-
Jargon is the technical terminology of any specialised field. It is commonly used when communicating with others in the same field. Communication problems can begin when jargon is used in material aimed at a more general audience.Ìý
Jargon also includes sub-technical words. These have multiple meanings in general and technical contexts. For example, the word 'fast' has very different meanings in medicine (resistant to), mining (a hard stratum under poorly constructed ground) and painting (colours not affected by light, heat or damp). A specialist dictionary may be required for learning technical and sub-technical vocabulary. Your lecturer can recommend a good specialist dictionary for your subject area.Ìý
Aim to write for your intended audience. If your report is for your colleague or supervisor, the use of jargon may be appropriate and expected. However, if you are writing a report for a general audience or an expert from another field, jargon should be avoided in favour of simple, clear descriptions.Ìý
-
Abbreviations are pronounced as letters (e.g. ºÚÁÏÍø´óʼÇ) and acronyms are pronounced as words (e.g. LASER). The first time you use an abbreviation or acronym, you must spell out the full term followed by the abbreviation or acronym in brackets. After this, you can use the abbreviation or acronym form.Ìý
For example: The University of NSW (ºÚÁÏÍø´óʼÇ) is situated on Anzac Parade, Kensington. The best way to travel to ºÚÁÏÍø´óÊÂ¼Ç is by public transport.Ìý
When choosing whether to write an abbreviation or acronym, consider how frequently the term will be used in your writing. If the term is only going to be used three or four times in a long report, it may be clearer to write the full term each time. This will also improve readability.Ìý
-
Is it permissible to use 'I' in technical writing? It depends. As a first step, we recommend that you check with your lecturer or tutor.Ìý
Reasons to use 'I':
The more practiced a writer is, the more latitude they have in being casual or creative.Ìý
If a writer is an accomplished engineer, scientist or other professional, then as an 'expert' in their field they can use 'I' to give authority to their ideas.Ìý
Reasons to not use 'I':
When 'I' is used too frequently, it can make your writing sound casual, informal and lacking in objectivity.Ìý
Not using 'I' can make your writing more believable. Readers may interpret your use of 'I' to mean that you are unaware of formal writing conventions and what other experts in the field have done. By following conventions, you demonstrate that you are aware of practices and key research in your field.Ìý
In a student's writing, 'I' can suggest absorption with the self or that the student does not recognise that their work needs to stand up to scrutiny.Ìý
-
What is different about these two sentences?
- Male guppies advertise their attractiveness by displaying their colourful patterns (active voice).Ìý
- Attractiveness is advertised by male guppies by displaying their colourful patterns (passive voice).Ìý
Using the active voice in your writing creates a direct and concise message, which makes your work easier for readers to understand. While we encourage you to use the active voice where possible, this does not mean you cannot use the passive voice. Passive voice can be convenient and necessary sometimes.Ìý
Most writing will have a combination of active and passive clauses depending on what word is chosen as the subject of a sentence. Look at course-related texts that you consider well-written to notice how and when writers use active and passive voice.Ìý
-
Using non-discriminatory language is a legal obligation for writers.Ìý
Aim for truthful reporting of facts and avoid statements that suggest bias or prejudice towards any group in your technical writing. You should also avoid making unsupported statements about a person's age, economic class, national origin, political or religious beliefs, race or gender.
For example, referring to all persons in an industry as 'he' can be inaccurate and misleading. It is best to name the profession using a gender neutral term, for example 'police officer' instead of 'policeman'.Ìý
The components of a report
Depending on its length and purpose, a technical report may include the following components:
- Title page
- Disclaimer
- Abstract
- Acknowledgements
- Contents page
- List of figures and tables
- List of symbols and definitions
- Introduction
- Main sections and subsections
- Conclusions
- Recommendations
- References
- Appendices
See also
 Looking for personalised study support?
Meet an Academic Learning Facilitator to get constructive feedback on academic skills.