Professional Documents
Culture Documents
Hydraulics and Water Resources Engineering Department: Debre Tabor University
Hydraulics and Water Resources Engineering Department: Debre Tabor University
Debre Tabor
Ethiopia, 2018
1. INTRODUCTION
In addition to the analytical and design skills which you need to become a successful engineer,
communication skills will be required throughout your career. Communication is the vital act of
transferring ideas from one person to another. The main modes of communication are written,
verbal, and visual. In the scientific community, written reports are one important mechanism
whereby this transfer takes place. As a practicing engineer, you will need to write reports,
proposals, and scientific papers. Writing is perhaps the most important way in which you will
convey your ideas to managers, other engineers, and customers. Your communication skills will,
therefore, determine how successful you are as an engineer, perhaps even more so than your
technical expertise. The ability to communicate your ideas or findings to others is as important as
the knowledge itself.
Correctness/Appropriateness
Conciseness
Conducive Environment
Feedback
Completeness
The most critical and obvious reason behind the collapse of any engineering structure is
poor communication.
1.4 Report
It is a highly structured document written in a formal style.
Normally a report is based on your reading and some practical works such as an
investigation, survey, experiment or review of practice in other organization.
Popular Report
Oral Report
The goal of an engineer is to write technical reports that are formal, logically organized
and easy to read and understand.
Describe what was done and how it was done. Present finding, conclusion and any
recommendation.
4) No repetition of facts
CHAPTER TWO
2.1 COMPONENTS OF A TECHNICAL REPORT
The technical report is a kind of writing you will engage in throughout your academic and
professional career. It should include the following sections:
1. Title page 5. Body
2. Abstract /executive summary a) theory
3. Table of contents b) apparatus
4. Introduction c) experimental setup/experimental procedure
a) The background d) sample calculation
b) The purpose 6. Result and discussion
c) The scope 7. Conclusion and Recommendation
8. References
9. Appendix/Appendices
2.1Title Page
The title identifies the subject and indicates the purpose of the study. The title should be brief
and meaningful and describe the contents of the report. The title page includes the title, author‟s
name, course name and number, lab section number, instructor‟s name, and is not numbered.
2.2 Executive Summary/Abstract
Technical reports typically require either an Executive Summary or an Abstract, but not both.
The executive summary should give a concise and clear overview of the entire laboratory
experiment or topic to be discussed and should be the main explanation of the entire report.
Readers should be able to gain all the necessary information from the Executive Summary and
sometimes will read only this part. It should be written in the third person, passive voice, and
past tense because it explains work already done. It should be a document which can be read
independently of the main report. It usually contains 100 to 200 words
This section provides a context for the work discussed in the report. Therefore,
It defines the experiment/work performed
It defines the scientific purpose or objective for the experiment
It includes a description of the problem and the reasons for the work being done
It gives sufficient background information to the report
It must answer the questions
Why was this study performed?
What is the specific purpose of the study?
2.5 Main section/body
This part presents the results to the reader
Depending on the types of the report this section can be divided into different areas as
literature review, methodology, results, and discussion
2.5.1 Results and Discussion
The results of the technical report should be analyzed, interpreted and stated clearly. The use of
figures and tables usually incorporated should have labels referenced in the text and fully
explained and interpreted. Any errors should be discussed and explained with regards to how
they occurred and how they affected the conclusion. An error analysis is usually an essential part
of the discussion and provides a comparison to expected results. Data presented as results should
be well organized. Numerical data should be included in graphs or tables to provide the best
possible information about the real situation. This section should answer the questions:
What do the results clearly indicate?
What was discovered?
What is the significance of the results?
Are the results fully discussed and conclusions drawn based on the knowledge gained?
How did errors occur?
Did any of the errors affect the conclusion of the experiment/study?
2.6 Conclusion
This section is the final part of the report used to summarize the key points from the main body
of the report relating them back to the introduction. This section should briefly summarize the
significant results of the experiment/the report. The conclusion:
Must answer any questions raised in the introduction regarding what was shown,
discovered, verified, proved, or disproved.
Must explain why the experiment was significant.
Must explain the implications for your particular field of study.
Should not include discussion of new information not already mentioned in the report.
The conclusion part does not introduce the new material in this section. This section must
explain the implications for your particular field of study.
2.7 Recommendations
This section provides you with the opportunity to suggest changes and improvements. Any
recommendations should be based on your conclusion.
2.8 References
The reference list should detail all the sources you have used in your report. It is in strict
alphabetical order.
2.9 Appendices
Useful information too long to fit within the body of the paper is placed in an appendix.
Typically appendices are used for long mathematical formulas and complete sets of data such as
tables or figures. All appendices should be referenced within the text of the report; items in the
appendices should be arranged in the order in which they are mentioned in the report itself.
Use this section to include material that the reader might want to refer to but would disrupt the
flow of the main report.
Each appendix is numbered so that it can be referred to in the report. Used for long mathematical
formulae.
3. Structure of Report
Fonts should be minimum of 12point and 1.5 line spacing is recommended unless otherwise
specified.
CHAPTER THREE
3.1 Visual Displays and Presentations
Tabular, Graphical, Chart and Pictorial Representations
Tables and figures are two major aids available to the technical writer. Written discussions can
be clarified by integrating tables and figures into the text. Tables present discontinuous, yet
numerically accurate information with no limit to the number of variables. The challenge in
using tables is to emphasize the most relevant trends. Figures include drawings, sketches,
photographs, maps, graphs, plans, and diagrams. An effort must be made to make figures
accurate and not misleading. Tables and figures are most effective when they are useful, clear,
self-explanatory, accurate, easily understood and remembered. They should have enough
explanation in their captions to stand alone, in case they are copied and used in presentations or
out of the context of the report. A table or figure should be placed in a consistent manner
throughout the report, either:
Inserted in the text immediately following the paragraph in which it is first mentioned in
the body (textbook style);
On a separate page which immediately follows the page where it is first mentioned (thesis);
At the end of the report in a separate section (journal paper submission).
Common rules regarding table composition and arrangement.
Never place a table on two pages if it can be arranged on one.
Tables must conform to the same margin requirements as the text.
Box headings all proper nouns and proper adjectives capitalized.
Compare items in the same column in ascending or descending order of rank.
Align all columns of figures by the decimal points.
3.1. Tables
Never place a table on two pages if it can be arranged on one. Long tables may be continued
from page to page. The second page should start with a continuation (e.g. Table 2-
Continued) and a header row.
Tables must conform to the same margin requirements as the text. If the table is too wide to
be accommodated within the required margins, even when placed broadside (landscape
mode), then reduction by the photographic process is a possible solution.
Box headings have the first letter of the first word and all proper nouns and proper adjectives
capitalized.
Compare items in the same column in ascending or descending order of rank.
Align all columns of figures by the decimal points.
Abbreviations and symbols may be used in box headings and the main body of the tables but
not in captions.
Footnotes to tables are placed immediately below the tables. These should include
abbreviations used in the table but not in the text.
Tables of more than two columns may be ruled. Minimize the number of lines used.
When presenting very large or very small numbers use the appropriate power of 10. Either
multiply the number in the table by the power of 10 (viz. 5.3 x 104) or the units in the box
heading by the power of 10 (viz. pressure x 10-4 psi).
3.2. Graphs
Since most readers are visually orientated, a graph will often be easier to analyze and remember
than written text. Line graphs or x-y graphs are used to show a relationship between two or three
variables. Bar graphs can be used to illustrate the effect of a non-numeric variable upon a
numeric variable. Pie charts can show the relative importance of a set of values upon the whole.
All graphs should be clear, self-explanatory and accurate. A few common rules to be followed
when graphs are prepared are given below.
Show coordinate axes and label them carefully. The dependent variable is plotted on the
ordinate (Y-axis) with the independent variable along the abscissa (X-axis).
Label each graph with a title and number.
The origin should appear on all graphs (except logarithmic).
Data appearing on graphs may be tabulated in an Appendix to the report to provide a record
of exact values.
Choose the ordinate and the abscissa scales so that points can be read with precision
approximately equal to the experimental error.
Choose the units for the ordinate and abscissa to be multiples of 1, 2, 5, or 10 rather than
odd multiples, viz. 2.8, 5.6, etc.
Do not clutter any graph with too many curves. Identify each curve with a label. Use a key
for several curves on a single graph.
Graph paper with a coarse grid is better than one with a fine grid because the ordinates and
curves are more predominant when there are fewer grid lines.
The most prominent feature of the graph should be the data and/or trend line. Next in
importance are the axes. Least important are gridlines. Therefore the line thickness should
decrease in the following order: trend line, axes (including ticks), legend box, grid lines.
EnLa 3221 Technical Report Writing and Research Methodology Page 9
Hydraulics and water resources engineering department 2018/2019
3.3. Diagrams
The importance of schematic diagrams, dimensioned drawings, plans and exploded views in
engineering report writing cannot go unmentioned. Schematic diagrams illustrate flow, but the
entities in them are not to scale. Dimensioned drawings, plans and exploded views can illustrate
the orientation of entities to each other. A dimensioned drawing of the apparatus constructed for
a research project is usually included. Large plans should be placed in a pocket at the back of the
report, but show the author's name and the date to ensure proper identification if separated from
the report.
CHAPTER FOUR
Careful attention to the mechanical details of a report will ensure a polished appearance and
professional touch. The neat well-ordered report indicates care and organized thinking. Both of
these qualities help the reader to form a favorable impression of the report and the author.
4.1. Paper
Print-out manuscripts with black ink on good quality paper of at least sixteen-pound weight cut
to the standard 215 x 280 mm (8.5" x 11") dimensions. Pages with unsightly marks and
corrections should not be incorporated into a finished report.
4.2. Margins
Adequate borders should be provided on every page of the manuscript to allow for binding and
trimming. Allow at least 38 mm (1.5") for the left-hand margin, 25 mm (1") for the top, right-
hand and bottom margins. Note that the margin requirements apply to the text and not the page
numbers.
4.3. Font
Use a common and easily readable font such as Arial, Courier, Helvetica or Times Roman. Use
the same font throughout the report.
4.4. Pagination
All pages of the report from the title page to the Introduction are numbered consecutively with
lower case Roman numerals (i, ii, etc.) centered at the bottom of the page. Although the number i
is assigned to the title page, it does not appear there. Consecutive Arabic numerals are used
throughout the remainder of the report to indicate page numbers. Each major component (e.g.
Introduction, Literature Survey, Experimental Details, etc.) which forms a complete chapter in
the basic report structure should begin on a new page with the Arabic numeral typed in the
bottom center.
All other pages may be numbered at the top right-hand corner or at the bottom center. Diagrams,
illustrations, and tables occupying a full page can be numbered near the bottom of the page at the
center (at the same position as the first page of a chapter). The List of References and
Appendices are numbered successively in their proper order of appearance with Arabic
numerals.
4.5. Numbers
Numbers are used more frequently in technical reports than in most other report forms. Several
rules pertaining to the use of numerals are given below.
Do not start sentences with numerals; use words (e.g. Ten feet of pipe rather than 10 feet
of pipe).
Use numerals for integers up to ten.
If the number to be used is not a common fraction (3/4, 1/2), it is preferable to use the
decimal form, viz. 0.73.
Precede the decimal point in a numeral less than one by a zero, viz. 0.383.
If two numbers follow consecutively in a phrase, viz. 3 2 ft diameter tanks, errors due to
misreading can result. Uncertainty can be eliminated by writing one of the two numbers
in full, viz. three 2 ft diameter tanks. Generally, the least important number is written out
but if neither number deserves emphasis, use the shortest written form. Be consistent in
parallel construction: three 2 ft diameter tanks, four 2 in. valves.
Use numerals for all data.
Report only those significant figures consistent with the accuracy of the readings.
Use numerals for percentages (10%), dates (1965), sums of money ($3000.00) and
numbers combined with abbreviations (15 psi.).
4.6. Equations
The presentation of equations in technical reports is often a source of great difficulty. Preparing a
preliminary Nomenclature as the report progresses can eliminate double-use of symbols.
Adhering to the following rules can facilitate the presentation of equations.
Number each equation at the right-hand margin. Equations occupying more than one line are
numbered at the right-hand margin on the last line.
Begin all equations on separate lines, centering them on the page if possible. Equations
requiring two lines or more begin on a paragraph indentation (five spaces) with each
successive line indented five additional spaces. For better appearance and clarity do not
crowd the text around equations.
If the equation extends beyond one line, break it before a +, - or = sign and place that sign at
the beginning of the next line.
Do not end a paragraph or a section with an equation.
In a series of equations separated by phrases or single words of text, each equation is still
placed on separate lines. Include normal punctuations when equations are parts of sentences.
Do not use the equal sign as the main verb in the sentence.
Exponential expressions are preferably written as exp(-ab/c), rather than e-ab/c.
Leave one space after trigonometric and hyperbolic functions, before and after +, -, and =
signs when used as operators (sin x, 2 + 2, 2x = y + z, etc.).
Do not leave a space between a symbol and its superscript or subscript (sin2 yo).
In built-up fractions, attempt to contain the equation on one typewritten line (y = 2x/3z).
A recommended order of closures for parenthesis, brackets, and braces, which are used
when necessary to avoid ambiguities, is the following: {[(....)]}
Symbols and abbreviations are used in technical reports for clarity and conservation of space.
When using abbreviations and symbols, ensure that all symbols and unusual abbreviations are
carefully defined in the text of the report. If there are too few abbreviations to warrant a
nomenclature section, abbreviations should be defined after they are first encountered in the text.
Since the use of symbols and abbreviations is specialized in the various scientific fields,
consistency can be maintained by referring to leading journals. Rules fundamental to the use of
symbols and abbreviations are as follows.
Use the symbol for percent (%) only when it is preceded by a number (e.g. 81.3%).
Do not abbreviate short words.
Except when using a nomenclature section, define all abbreviations on first use (e.g.
green sulfur bacteria (GSB) was used in this ...). Avoid using abbreviations in the
abstract.
Do not insert space between letters of abbreviations such as NASA, AECL, etc. (not N A
S A, etc.).
Do not use an apostrophe in making an abbreviation plural (e.g. PAHs, not PAH‟s).
4.8. Headings
A well-organized report reflects the logical thinking of the author. Proper headings can break the
report into logical sub-sections which are easy to find by using the index. All headings should be
distinguished from the rest of the text by placing the heading on a separate line and by the use of
bold fonts. Be consistent with the font sizes used for each degree of heading and the spacing
between the headings and the following text. A number system has been used in this report
which enables the reader to understand how the section s/he is about to read fits in with the
whole. Technical reports are normally written in chapter form unless they are of such short
duration that this possibility is precluded. Each new chapter title is in upper-case, bold, centered
at the top of a new page, and preceded by the chapter number. When second-degree headings are
used, each heading is displayed in caps and lower-case letters and indented five spaces, or about
10 mm. Subsequent paragraphs are indented five spaces.
Third-degree headings are displayed in caps and lower-case letters and indented ten spaces while
all subsequent paragraphs are indented ten spaces.
4.9. Spacing
Reports should be typed double (line) spaced, except for figure and table captions, higher order
headings in the table of contents, literal quotes, and references. A double space at the end of each
sentence after the period improves readability.
4.10. Spelling and Grammar
A report with numerous spelling and grammar errors may be rejected outright by the evaluator.
Do not depend on the word processor to identify all errors. Have the report read by a colleague
prior to submission?
CHAPTER FIVE
Critical:- many truths are tentative and are subject to change as a result of subsequent research
intolerant views
R&D is interdependent
Lack of records
gathering information
It is designed to solve practical problems rather than to acquire knowledge for the
knowledge sake.
yields findings that can be evaluated in terms of local applicability and not in
terms of universal validity
Qualitative research
Seeks to describe various aspects of behavior and other factors studied in the social
sciences and humanities.
In qualitative research data are often in the form of descriptions, not numbers.
But sometimes results of qualitative research are subjected to relatively less rigorous
quantitative treatment.
Quantitative research
The systematic and scientific investigation of quantitative properties and phenomena and
their relationships.
It favors methods such as surveys and experiments, and test hypotheses or statements
with a view to inferring from the particular to the general.
Descriptive research involves a variety of research methods to achieve its goal. The
methods that come under descriptive research are:
Surveys,
Correlation studies,
Observation studies,
Case studies
The empirical research relies on experience or observation alone, often without due
regard for system and theory
Its intent is to present a focused and scholarly presentation of a research problem and
plan.
The objective in writing a proposal is to describe what you will do, why it should be
done, how you will do it and what you expect will result
A good research proposal hinges on a good idea. Getting a good idea hinges on
familiarity with the topic.
Defining the problem is the first step and one of the most difficult in research
undertaking.
It is the crucial part of a research study and must in no case be accomplished hurriedly.
Before deciding on a research topic, each proposed topic must be compared with all other
options.
Relevance/Significance
Avoidance of duplication
Applicability of results
Ethical acceptability
Internal
It is done by a staff specialist by the research department within the firm.
External
These are sponsored by other sponsors, such as NGOs, industry or government agencies.
They can be further classified as solicited or unsolicited.
2. The controversial subject should not become the choice of an average researcher
4. The subject selected for research should be familiar and feasible so that the related
research material or sources of research are within one‟s reach.
5. The importance of the subject, the qualifications and the training of a researcher, the
costs involved, the time factor
Understanding the nature of the problem: understand its origin and nature
Surveying the available literature: All available literature concerning the problem at
hand must necessarily be surveyed and examined.
Rephrasing the research problem: Finally, the researcher must sit to rephrase the
research problem into a working proposition.
Operational definitions
Plan of data analysis
10. Work plan
11. Budget
12. Reference
13. Appendices/Annexes
Title page
Must be well studied, and to give, so far as its limits permit, a definite and concise
indication of what is to come.
should state the topic exactly in the smallest possible number of words.
Put your name, the name of your department/faculty/college, the name of your advisor(s)
and date of delivery under the title
A good title is defined with the fewest possible words that adequately describe the
contents of the study
Summary/Abstract
one page brief/concise summary of the thesis proposal or the material presented in the
proposal
it enables the reader to identify the basic content of a document quickly and accurately, to
that end, it needs to show how your work fits into what is already known about the topic
and what new contribution your work will make
Characteristics of an abstract
Introduction/background
Is the part of the proposal that provides readers with
the background information for the research proposal.
All cited work should be directly relevant to the goals of the research.
Explain the scope of your work, what will and will not be included
Effective problem statements answer the question why does this research need to be
conducted
A well‐
articulated statement of the problem establishes the foundation for everything to follow in
the proposal and will render less problematic.
Literature review
Provide a summary of previous related research on the research problem and their
strength and weakness and a justification of your research
Newspaper articles
Historical records
Hypotheses /Questions
Question: an interrogative statement that can be answered by data
Poses a relationship between two or more variables but phrases the relationship as a
question
It describes in concrete (rather than theoretical) terms what you expect will happen in
your study
E.g. say you predict that there will be a relationship between two variables (A and B)
in your study
The other that describes all the other possible outcomes with respect to the
hypothesized relationships
Your prediction is that variable A and variable B will be related. Then the only other
possible outcome would be that variable A and B are not related
The hypotheses that describe the remaining possible outcomes is called the null
hypothesis
Conceptual framework
Is a research tool intended to assist a researcher to develop awareness and understanding
of the situation under examination
Is a set of broad ideas and principles taken from relevant fields of inquiry and used to
structure relevant fields of inquiry and used to structure a subsequent presentation
the starting point for reflection about the research and its context
General objective
What exactly will be studied?
Specific objectives
Specific statements summarizing the proposed activities and outcomes and their
assessment in measurable terms
Should systematically address the various aspects of the problem as defined under
„Statement of the problem‟ and the key factors that are assumed to influence or cause the
problem.
Research Methodology/Methods
The heart of the research proposal
Decide exactly how you are going to achieve your stated objectives
What to do and how to solve the problem and achieve the proposed specific
objectives?
Which research methods (e.g. survey, modeling, case study …) will be used.
Research Design
Definition
Components
Information needed
Its function is to provide for the collection of relevant evidence with minimal expenditure
of effort, time and money
Scope of research
Type of research
Research planning
A Research Plan is a document explaining the plan of the study/research project from its
start to the end.
2. When to do
3. What to achieve
4. When to stop
Statistical design: how many items are to be observed and how they shall be analyzed.
Operational design: the techniques by which the procedure specified in sampling, statist
ical and observational design are carried on
Cross‐sectional designs
Involves collection of information from a sample of respondents only once
Longitudinal Designs
A fixed sample of the population is
measured repeatedly, i.e., same respondents studied over time
Planning
Identify the problem or topic
Gathering Data
After planning your research study, the next phase is systematically gathering your data
(information) in an ethical manner
Primary Data
Secondary Data
Reporting results
Analyze the data
Report results: make sure to discuss what practical or theoretical implications can be
drawn from the findings
Principal investigator; supervisor; data collector; drivers; guards; data entry clerks, data
analysis, report writing, etc.
Publication: the cost incurred of preparing and publishing the results of the research.
Indirect costs:
Includes;
Measurement
The process of assigning numbers or labels to objects, persons, states, or events in
accordance with specific rules to represent quantities or qualities of attributes.
A true difference in the characteristic being A true difference in the characteristic being
measured.
Example.
Ordinal scales allow the respondent to Ordinal scales allow the respondent to express
“relative magnitude” between the raw responses to a question
Example.
Scales of measurement…
Ratio scales: for the identification of Ratio scales allow for the identification of absolute
differences between each scale point, and absolute comparisons between raw Ratio scales
allow for the identification of absolute differences between each scale point, and absolute
comparisons between raw responses
Example1.
Please circle the number of students above 40years of age currently enrolled in the PG
program. 0 1 2 3 4 5 6 7 (if more than 7, please specify ___.)
Interval scales demonstrate the absolute Interval scales demonstrate the absolute
differences between each scale point
If a nominal scale is used, analysis of raw data can only be done using modes and
frequency distributions
If ordinal scales are used analysis of raw data can be done using medians and ranges
(plus modes and frequency distributions)
If interval or ratio scales are used, analysis of raw data can be done through the use of
sample means and estimated standard deviations as the means and estimated standard
deviations as the sample statistic (plus the above)
In a survey, the investigator examines those phenomena which exist in the universe
independent of his action.
Fact that some people are rarely accessible to direct observation creates an obstacle
Questionnaire
Sampling
A sample is a subgroup of the population selected for the study
Sample statistics allow making inference about the population parameters, through
estimation and hypothesis testing.
The sample space is a complete set of all possible results of the sampling procedure
Probability/Nonprobability sampling
Systematic sampling
Stratified sampling
Nonprobabilistic samples
Convenience sampling
Judgmental sampling
Quota sampling
Snowball sampling
Convenience sampling
Only “convenient” elements enter the sample
Judgmental sampling
Selection based on the judgment of the researcher
Quota sampling
1. Define control categories (quotas) for the population elements, such as sex, age…
2. Apply a “restricted judgmental sampling”, so quotas in the sample are the same as those in the
population
Data Analysis
The data obtained from a study may or may not be in numerical or quantitative form, that
is, in the form of numbers.
If they are not in numerical form, then we can still carry out qualitative analyses based on
the experiences of the individual participants.
If they are in numerical form, then we typically start by working out some descriptive
statistics to summarize the pattern of findings.
These descriptive statistics include measures of a central tendency within a sample (e.g.
mean) and measures of the spread of scores within a sample (e.g. range).
Another useful way of summarizing the findings is by means of graphs and figures.
Data Presentation
Information about the scores in a sample can be presented in several ways.
If it is presented in a graph or chart, this may make it easier for people to understand what
has been found, compared to simply presenting information about the central tendency
and dispersion.
Frequency polygon
a graph showing the frequencies with which different scores are obtained by the
participants in a study.
Histogram
a graph in which the frequencies with which different scores are obtained by the
participants in a study are shown by rectangles of different heights.
In a histogram, the scores are indicated on the horizontal axis and the frequencies are
shown on the vertical axis.
Bar chart
a graph showing the frequencies with which the participants in a study fall into different
categories.
In a bar chart, the categories are shown along the horizontal axis, and the frequencies are
indicated on the vertical axis.
Conclusions
A short summary of your results or findings
Recommendations
EnLa 3221 Technical Report Writing and Research Methodology Page 36
Hydraulics and water resources engineering department 2018/2019
If possible quantify the benefits that can be gained from following the recommendations.
Indications as to what other techniques can be applied to improve the systems viz.
References
There are a variety of ways to reference material used in a report. You must use the APA
Publication Manual in listing your references.
Include only the sources that were used in the project. Below is just one example.
Journal Article the journal article title is italicized, the figure following is the volume
number, with the issue number after the oblique and then the page numbers)