Engineering Report Writing Guide - 2003
Engineering Report Writing Guide - 2003
MOW 323
2003
Excerpts from:
Steyn, T. 2003. JPO Communication manual. Five Year Study Programme.
School of Engineering. UP.
Contents
Introduction
Writing in engineering .......................................................................................... 1
i
Writing in Engineering
This manual contains information to assist you in improving your academic and scientific
communication skills. Special attention is given to academic and scientific writing skills. We refer to
these activities as writing-to-learn and learning-to-write in engineering. Why do you need to write?
The immediate value of writing is a better understanding of the subject material. The process of
finding, analysing, organising and presenting information is an invaluable aid to learning. Writing is
an excellent way of helping you crystallise your ideas and coherently express your understanding of a
subject. So, the process of writing an assignment, painful as it may seem at times, helps a student
understand and integrate new information and material. Needless to say, understanding the subject
material will benefit your final grades!
Taking a broader view, writing to learn will help develop your ability to think intensely and
productively for longer and longer periods. In addition, by completing the various writing
assignments, you will become a better writer, a better communicator. Learning to convey information
on paper in a clear and professional manner is part of your training for a career as an engineer. Do not
underestimate the importance of this benefit: the ability to communicate is one of the most important
attributes employers look for in job applicants.
Furthermore, the Engineering Council of South Africa (ECSA) requires that engineering graduates
must demonstrate, amongst others, an ability to communicate effectively, both orally and in writing,
with engineering audiences and the community using appropriate structure, style and graphical
support.
In this manual aspects are addressed that will assist you in the knowledge and skills needed for
academic and scientific writing and also for the writing that you will eventually have to do as an
engineer. Please keep this manual for future references.
____________________________
1
Section A: Writing Guidelines
2
Common mistakes in English
1 General
Do not use an American dictionary to spell check a document.
Use the "-ise" spelling instead of "-ize".
Use the following word order: subject-verb-indirect object-direct object
2 An or a?
An: For words beginning with a e i o u; silent h; single letters a e f h I l m n o r s x
A: For all other words; single letters b c d g j k p q t u v w y z
Noun nearest to verb is used when: The first noun is used when:
Either … or With
Neither … nor Together … with
Not … but As well as
Not only … but also Including
e.g.: Neither the lecturer nor the students are ill. e.g.: The lecturer as well as the students is ill.
3
Common mistakes in English
5 Vocabulary
affected by / the effect of
extent of / extend the (extent is a noun; extend is a verb)
Fewer numbers but less quantity
Owing to (=because of) / due to (=caused by)
6 Prepositions
Aim at move into
under the circumstances multiply by
complain of within a time period
compliment on for a period of time
different from place onto
disqualified from reaction to
divide by/into in respect of
exception to succeed in
exchange a – for a – surprised at
in front of
7 Usage
Use the following: rather than:
percentage percent
performed; investigated done
researchers, professionals persons
several, various a number of
x metres long x metres in length
8 My personal reminders:
4
Tips on English usage
2 A sentence
The structure of a simple sentence: The dog bit the man.
subject-verb-object
Sentences are made up of clauses; there are just five clause elements, namely, subject, verb, object,
complement and adverbial:
(s) The teacher / (v) has called / (o) me / (c) a genius / (a) several times.
Keep your sentences short.
3 A paragraph
A paragraph is a visual unit.
It is separated from the rest of the text by being indented at the beginning or by an open line between it
and the next paragraph.
A paragraph is also a thought unit. Each paragraph develops one main idea in a number of related
sentences. To find the main idea or topic or subject, we ask "What is this paragraph about?"
The topic or main idea of a paragraph is usually stated in one of the sentences of which it is composed.
This sentence is called the topic sentence.
By far the most common position for this topic sentence in a paragraph is at the beginning, but it is not
always the case.
Sometimes a paragraph does not have a topic sentence. However, there is usually one main idea that
you can state by formulating your own topic sentence.
5
Hints
6
Hints
7
Writing reports and papers
1. Introduction
A report is the formal writing up of a piece of research or project work. Reports are usually written up
in a concise style giving precise detail. A research paper refers to a written journal article or to a
contribution made at a conference. The latter usually comprises a written document that is published in
the conference proceedings and which is also presented orally at the conference.
Most of the writing done by engineers consists of reports and papers. The purpose of these is to
transfer information to the reader. Different readers will have different requirements from a report or
paper. A managing director will probably not have time to read the report but will be interested in the
most important results and recommendations. Somebody paging through a technical journal needs to
establish quickly if a paper is of importance to him/her. Once this has been determined, the reader may
be interested in checking the information in the finest detail: What was done? How was it done? What
is the result?
Novice technical writers usually experience problems with the structure (format) of their writing and
with meeting the demands of accuracy, brevity and clarity.
The following guidelines aim to prescribe a structure for writing technical reports and papers and to
assist you by detailing the exact requirements of the different sections of a report/paper. During your
further studies, your department may have some specific additional requirements that you will have to
adhere to.
8
Writing reports and papers
Page numbering: Note that the pages of a paper are numbered from the title page using Arabic
numbers. Headings are not necessarily numbered. If the headings are numbered, the number 1 is
assigned to the Introduction.
9
Writing reports and papers
5.1.0.1 Institu
Mass Acceleration Top speed Hill climb Endurance
tio Car no
(Kg) (m/s2) (km/h) (s) (laps)
n
Potch Univ 3 230 5.94 32.03 14.43 75
RAU 4 192 4.92 41.96 0 49
Techn Pretoria 5 171 5.64 44.96 12.57 34
UCT 6 164.5 4.62 40.36 11.75 22
RAU 7 172 8.46 27.11 0 2
UCT 9 179 5.20 42.25 15.62 55
Tuks 11 171 5.01 43.69 11.26 85
Wits 26 146 4.23 47.75 9.65 40
Note: Be consistent with the format of your numbering and labelling system throughout your
paper/report.
10
Writing reports and papers
6.1 Title
The title of either a report or a paper is a short, informative description of the investigation. It must be
unambiguous, free of all unnecessary words, but must contain the important keyword describing the
investigation. Many technical journals limit the title to 15 words.
11
Writing reports and papers
6.4 Keywords
Keywords are used in information retrieval systems. During a subject search, papers with a certain
keyword or combination of keywords are selected. You have to select a maximum of five words that
distinctly characterise the content of the report.
6.5 Introduction
The purpose of the introduction is to put the reader in the position where the author was before he/she
started the investigation.
The following usually appear in the introduction:
• Background
• Problem statement
• Purpose of the investigation
• Method (very briefly), scope and/or limitations
Background information is necessary to orientate the reader regarding the context of the report.
The problem statement outlines the motivation for the investigation. For example:
The feasibility of a filtration technique to purify a locally available raw material containing potassium
was investigated. This investigation was necessary because of a shortage of potassium for the
manufacturing of explosives.
The method, scope and limitations are mentioned only. Only a few sentences are required to cover
this. Further details are then given in the body of the report. For example:
The efficiency is determined experimentally in a laboratory scale investigation. Because of
compressed air limitations, the investigation is limited to 300kPa.
or
The number of swimming pools in the Pretoria municipal area was determined from aerial
photographs. Indoor pools are, therefore, not included in the report.
6.7 Method
For reports adhere to the following:
In reports the planning, apparatus, and experimental methods are described in some detail. These can
be included in one paragraph or each can be assigned a separate paragraph. The descriptions and/or
references must be complete enough to enable the reader to repeat the experimental work.
12
Writing reports and papers
• Planning
Name the independent variables and motivate the choice. Motivate the range of values
investigated for the independent variables used. Show and motivate the choice of dependent (or
measured) variables. Show the experimental design. In your further study you will need to consult
good books on experimental design.
• Apparatus
Describe the apparatus used. Use sketches and give dimensions if necessary. Give equipment type
and model number etc.
• Experimental procedure
Describe the methods used in the experimental work and analysis. Use references freely; also
references to standard methods and techniques pertaining to your field of study.
6.8 Results
Report the most important results first unless this would impede the logic and flow of the argument.
Use graphical and tabular presentation judiciously. Indicate important points to the reader. It often
makes more sense to report the results and immediately discuss their significance. In such instances
change the heading to: Results and Discussion. The separate discussion section will then be omitted.
In reports, illustrate data manipulation using complete sample calculations. If it is feasible (for
example in laboratory reports) sample calculations are placed in the text. In reports in practice, sample
calculations are placed separately in an appendix and referred to in the text. In the case of large
projects, make meaningful subdivisions so that results do not disappear in the variety of data,
calculations, etc.
In papers, data manipulation and sample calculations are not shown. If necessary the original report is
referenced. It may be necessary to describe briefly how the observed values were manipulated to
arrive at the information presented.
6.9 Discussion
The results of most technical reports are in the form of correlations between different variables. The
correlations must be explained using acceptable theories and mechanisms. It is strongly recommended
that you also use appropriate graphical representation to visualize relationships between variables.
You must always use the X-axis (horizontal axis) for the independent variable.
In case of research projects new theories or mechanisms must be formulated. From the viewpoint of
the project leader's evaluation, this is a very important section. It gives an indication of the author's
insight into the problem.
6.10 Conclusion
This section is a resumé of all the conclusions already drawn in the discussion section. There will
consequently be repetition. The most important conclusions must be mentioned first, unless this leads
to bad logic or loss of argument. Note that no new material, information or results may be introduced
at this point. All the conclusions must flow from the aims and purpose of the investigation as stated in
the introduction.
13
Writing reports and papers
6.11 Recommendations
Findings may lead to actions that should be considered. The recommended actions are summarised as
recommendations. All recommendations must be motivated from the conclusions. Do not include
recommendations in the heading if there are no real recommendations to be made. If the scope of the
recommendations do not justify a separate heading, the recommendations can be combined with the
conclusions in the same section.
6.12 References
References should not be confused with headings like "Bibliography" or "Further reading".
All references must have been referred to in the text.
14
Writing reports and papers
6.11.5 References in the reference list according to the Harvard reference style
1. References to books with one author:
Author, A.B. 1999. Name of book. (2nd or later edition). Place of publication: Publisher.
e.g.: Herrmann, N. 1995. The creative brain (2nd edition). U.S.A.: Quebecor Printing Group.
5. References to newspapers:
Author, A.B. 1999. Title of article Newspaper. Day Month:page.
e.g.: Ramphele, M. 1998. South Africa must invest in its intellectual capital or pay the price later.
Sunday Times 24 May:24.
6. References to reports:
Author, A.B. & Author, B.C. 1999. Title of report. Organisation. Type of report, report number.
Place.
e.g.: Du Plessis, I. 2001. Five Year Study Programme Annual Report 2001. Pretoria: University of
Pretoria.
7. References to dissertations/theses:
Author, A.B. 1999. Title of thesis. PhD-thesis. Place: Organisation.
e.g.: Steyn, J.L. 2002. Hydraulic amplification for actuation in MEMS. Masters Dissertation. Boston:
Massachusetts Institute of Technology.
9. WWW references:
Author, A.B. 1999. Title of the article.
www address in full (Accessed on Day Month 1999).
e.g.: Pritchard, T. 2001. The return of steam.
http://www.industry.gov.au/resources/netenergy/aen/aen21/19steam.html
(Accessed 7 July 2003).
15
Writing reports and papers
6.13 Appendices
Reports
The previous sections form the core of the report. A good reporter will arrange them to form a logical
overview of the project. To achieve this, it is usually necessary to exclude raw data, cumbersome
calculations, supporting results (for example standardising of equipment) and documentary material
(e.g. graphs used in calculator and computer programs) from the main body of the report. Such
material is then put in appendices as appropriate paragraphs and subparagraphs. Only one aspect is
treated per appendix. Each appendix is provided with a number and descriptive heading and is
indicated by page number in the table of contents.
Appendices should not contain unedited graphs, tables or figures. The symbols and language used in
the appendices must be the same as in the rest of the report. If computer programmed results are used
in appendices, these must preferably be in the same letter type as the rest of the report. Printouts of, for
example, statistical data, must be edited (or retyped) to eliminate unnecessary information and
undefined variables.
Papers
Only in exceptional cases will a paper contain an appendix. Such an appendix should preferably not be
more than one page and will not necessarily start on a new page.
____________________________
16
Important notes on report writing
1 Layout
• Use a logical system of headings and subheadings. Use a hierarchical report structure, but be
careful that this will not cause the report to become unwieldy (clumsy). Be especially careful of
using multiple levels of paragraphs and sub-paragraphs.
• Keep sections short.
• Where possible, place long lists of facts in tables rather than in text.
2 Comprehensiveness
A report must be comprehensive, providing all conclusions of importance (including negative results).
However, trivial findings should be omitted, but judgement must be exercised to decide which results
are significant.
3 Plagiarism
Take extreme care not to commit plagiarism under any circumstances. Always acknowledge work
done by somebody else. During your study at the university, any report will be rejected if plagiarism
was committed.
4 Scientific proof
Provide scientific arguments and motivate every statement that you make or provide a reference
pertaining to the required motivation. Contents must be free of any unfounded assumptions and must
be objective. Never base arguments on so-called "engineering judgment". Never give unfounded
opinions. Be exact, correct, clear in all motivations. Be especially cautious not to give the perception
of preconceived conclusions (that you want to 'prove' something).
5 Accuracy
Check the accuracy of technical information and data, not only for errors, but also that conclusions are
given without bias or wrong emphasis.
6 Style
Write the report in the passive form – never refer to the first or second person (I or you). The past
tense must be used to describe work that was done (e.g. "speed was measured"). Use present tense for
the discussion of results and conclusions (e.g. "… it is therefore concluded…").
7 Readability
Write the report with the specific reader (audience) for whom it is intended in mind. The meaning of
each sentence must immediately be apparent. Do not expect from a reader to read through the
remainder of a paragraph to understand an earlier sentence.
8 Language
Use a formal academic, crisp and to the point style of language. Vary the length of sentences. Avoid
unnecessary long sentences. Do not include superfluous information, but, on the other hand, do not
omit any essential information. Always write complete sentences. Do not use abbreviations.
17
Important notes on report writing
9 Paragraph structure
Start each paragraph with one sentence describing the theme of the paragraph (topic sentence). The
remaining sentences of a paragraph must provide (technical) detail. Each sentence should ideally
convey one aspect of this detail. Do not describe more than one important concept or give more than
one fact per paragraph. Use bulleted or numbered lists to give more than one fact (see the bulleted list
in 10 below).
10 Grammar
• Check language and terminology.
• Check for the appropriateness of every word and sentence that you use.
• Check each word to ensure that the correct English word is used.
• Be specific with no possibility of misinterpretation.
• Be consistent with the terminology you use.
• Do not use colloquial (casual) language, slang or emotive words.
• Avoid ambiguity such as "more rugged vehicles" (are these a larger number of the same strength
or the same number but stronger?)
• Do not endow objects with human attributes, e.g. "the equipment refused to operate".
• Avoid vague expressions and clichés such as "it would seem" or "it is clear".
• Avoid the common errors in English (see Points to Remember and errors to avoid Section A-2).
____________________________
18
Section B: Tips on reading and talks
19
Tips on reading
RECALL – Why?
Research shows that 40-50% of the material we read is forgotten very shortly (about 15 minutes) after we read it.
Immediate recall is an essential first step toward continued retention of the material.
RECALL – How?
After reading each small section of material, choose one (or more) of the following methods:
1. Recall mentally or recite orally the highlights of what you have read.
2. Ask yourself questions (maybe the same ones you used before you read the section) and answer them in your
own words.
3. Underlined and make marginal notes of the key words or phrases in the section. Underlining after you read is the
best way to decide what’s the most important information to remember.
4. Make separate notes or outlines of what you have read. This technique often works for more technical
material, which you need to put into your own words.
5. Recall with a friend. What you don’t recall, he/she might.
20
Tips on talks
TIPS ON TALKS§
#
Richard M. Felder
Department of Chemical Engineering, North Carolina State University
So you've got to give a formal talk in your class--a presentation on a term project or in a laboratory or
design course or a class on public speaking. That can be a scary prospect if you're not used to doing
things like that. Everybody's nightmare is looking foolish in public, and a public speech seems to most
people like a perfect opportunity to do just that.
It really shouldn't be that frightening. Almost every day you have the experience of talking when
others are listening to you and you don't even think about it--you just do it and it works out fine.
There's something about giving a SPEECH, though, that gets people into a total panic. I'm not talking
about feeling a bit nervous before the talk, you understand: stage fright is perfectly normal and a little
of it may even make the talk better. (If you're too relaxed you could seem bored with your topic, and
speakers who sound bored lead to audiences who are bored.) If your fear goes too far over the line,
however, it can cut way down on your ability to communicate.
There are a few things you can do to make your talk effective--and if you know it's going to be a good
talk, your pre-talk jitters are much more likely to stay under control. Good speakers all learn these
tricks sooner or later. Sooner is better than later.
Preparing
• Speak to your intended audience at their level. Avoid unnecessary jargon, and also avoid material
you know will be obvious or trivial to them.
• Include a clear introduction (motivate and preview your talk), body, and summary (conclusions,
recommendations).
• Never present a large body of information without summarizing the main points on an overhead.
Be aware that your audience can only absorb a small fraction of what they hear and much
more of what they can see.
• Use overheads containing mostly short bulleted lists, diagrams, and charts. A picture is worth a
lot more than a thousand words. If possible, use presentation software (like PowerPoint) to
generate the overheads.
• Use large type. Anything smaller than about 24-point will be hard to see in a large room.
• Charts are better than tables. Lower case is better than all capitals.
• Skip (or at least minimize) the math. Collections of equations are usually boring and/or
incomprehensible in a lecture. If you're talking about a mathematical model, focus on what it
does (predicts, correlates) and how well (or poorly) it works. If anyone wants details of the
math, they can ask for them later. (They won't.)
• If you show flow charts or plots, make sure they're completely labeled. A chart with lots of
unlabeled blocks and lines with arrows is pretty useless, as is a plot of W vs. x with no clue
about what W and x are.
• Plan a closing line. Even if you give a great talk, ending it with "Um, I guess that's all I've got" or
"I think that's the last slide" will do nothing for your cause. Say something like "That
concludes my presentation--thank you for your attention" or "I'll be happy to take questions
now--thanks for coming " or simply "Thank you."
• Rehearse several times and make sure the timing is right. Try to come in at least two minutes
under your target time for the presentation. If you're running longer than that, find ways to cut
it down.
21
Tips on talks
Presenting
• Never read word-for-word from a script. Very few people have the skill to read directly from a
prepared text without putting their audience to sleep. Use the points on the overheads to guide
you through the talk.
• Make frequent eye contact with people in every part of the room. Don't just look at your notes or
the screen or the people directly in front of you.
• Try to sound interested in your subject. If necessary, fake it. An obvious lack of interest on the
part of the speaker almost guarantees that the talk will not go well.
• Keep track of the time. If you see you're running short or long, try to adjust the speed of your
presentation to compensate.
• If you take questions, remember that "I'm sorry - I don't know" is a perfectly acceptable answer.
Trying to bluff your way through a tough question is usually a losing proposition.
And that's all there is to it. These practices may not make you the world's most spellbinding speaker,
but they're bound to make your talk much better than it would have been without them. They also may
not make speaking in public one of your favorite experiences, but they'll probably make you feel better
about it than you do now and every little bit helps. Give them a try in your next presentation and see if
they don't work for you.
____________________________
§
http://www.ncsu.edu/effective_teaching/Papers/speakingtips.htm
#
Professor Felder is the Hoechst Celanese Professor Emeritus of Chemical Engineering at North Carolina State
University. He has contributed over 200 publications to the fields of science and engineering education and
chemical process engineering.
He offers more useful hints for students on his web page:
http://www.ncsu.edu/effective_teaching/Student_handouts.html
22