Professional Documents
Culture Documents
Reporting
Reporting
Chapter Five
Thoughtfulness:
What is written has been thought of several times over
Persuasive and economical, both in structure and words
Correctness:
Grammar, punctuation, spelling, and proper syntax
Appropriateness:
Have the right tone (professional) and avoids verbosity
Readability:
Text flows smoothly, reader knows where the paragraph is
heading, summaries may be used to assist the reader to digest
the chapter or section.
Haramaya University, HiT, SECE Research Methods 5/27/23
Elements of Good Technical Writing…
7
Points to remember
Be succinct and formal: Try to say a lot in few words
Preparing :
Assess your readers
Establish clearly you writing goals
Frame and keep the main points and the overall report
in mind.
Organizing
Composing
Reviewing with the view to revise
Issues to remember
Not properly identifying your reader usually leads to
some mistakes in writing (such as use of abbreviations)
Anyone who picks up to read your writing is either
interested in acquiring new information or achieving a
better understanding.
in order to serve the reader, your paper should have
pertinent information.
the information you would like to convey must be presented
in an arrangement such that the reader will not spend an
inordinate amount of time in extracting the information
Haramaya University, HiT, SECE Research Methods 5/27/23
Steps in Writing: Preparing: Purpose
12
Organizing
Decide on the structure and outline
Prepare a complete outline for each element of the structure
Decide on and make the basic units of the structure
Organize the Units
Write about the structure so that your reader understands
how your report is organized and presented.
Write an outline for every chapter/section
Select the main points or ideas to be included and the order
of their presentation
Title
Acknowledgement
Abstract
(Table of Contents)
(Lists of Figures and Tables )
Introduction
Literature Review
Materials and methods
Results
Discussion/Conclusion
References
Appendices, where applicable
“An abstract is the summary of the paper that is read the most. “
Even though, the abstract immediately follows the title page, it is usually best to
write it after you have written the entire paper
The abstract is a short summary of the information in the paper that provides an
overview of the purpose, scope, and findings contained in the report
An abstract should include
the principal objective and scope of the investigation
describe the methodology employed
summarize the results and
state the principal conclusion.
Abstract thus provides an “in a nut shell” description without providing
underlying details
If the title is the bait that lures the reader, the abstract is the hook that
captures his/her attention to continue reading
Haramaya University, HiT, SECE Research Methods 5/27/23
Introduction
19
The Introduction prepares the reader to read the main body of the report.
It focuses on the subject, purpose, and scope of the report.
The Subject defines the topic and associated terminology; may include theory,
historical background, and its significance.
The Purpose indicates the reason for the investigation, objectives.
The Scope indicates the extent and limits of the investigation
State in the introduction
statement of the problem
problem must be pinpointed;
Goals and significance of the study
Relation to other issues
Purpose of the study relative to the problem
Review, critique, and summarize related research
Conclusion
Is summary of the report – the work and the results.
Restatement of results:
What are the factual findings that resulted from your research?
What are you implying as a result of these findings?
Concluding Remarks: What are your opinions based on the findings and results?
Recommendations :
may indicate a course of action on the applications of the results and findings or
suggestions for future work
The results you obtained are not isolated from previous scientific knowledge.
you not only provide the reader with interpretation of the results, but you are also
expected to put your interpretation in context of the existing body of scientific
knowledge.
N.B. Establish a clear and unambiguous statement on how your interpretation of
the results has addressed your objectives
The references section is the place where the author cites all of the secondary
research sources that were used
This section lists all the previously published sources of information that you
have cited in the body of the paper.
Only the papers cited, not all the papers that you have read or consulted, are referenced.
If you deem a source of information should be cited in the references section, then you
must have mentioned it in the body of the paper.
Example: In the text:
[3]; Name et al. [4];Name(1993).
In reference list
[3] J.Strohbehn, Ed. Laser Beam Propagation in the Atmosphere. New York: Springer,
1978.
[4] E.Shin and V.Chan, “Optical communication over the turbulent atmospheric channel
using spatial diversity" in proc. IEEE Conf. Commun., 2002, pp. 2005-2060
Message 2
Sub-messages
Cover - Title
Authors/Affiliations
Introduction
Problem statement;
Check regularly whether
Research question
are you focusing on the main
Literature review
points
Main
Check regularly for logic
Research method
Research design
and structure
Key assumptions Keep the allotted time in
Results/discussion mind
Ending
Implications/conclusion & recommendations
Limitations of results;
Future work
Visual aids
VAs enhance understanding of topic
VAs guide you through your presentation
Computer/LCD
Check how to operate before talk
How/where page up/down
Overhead
Avoid hand writing
Landscape
Handout
For failure of Vas
To stay at a particular slide
Stylistic Issues:
The Slide
Despite the fact that it is commonly called “oral presentation” it is equally
visual as it is an auditory medium.
The slide should be clearly visible and legible to the audience members sitting
even at the very back of the room.
We have to consider Layout, Background , Font
Layout:
The background color of the slide & the color of the text should have a
sharp contrast
If unsure about what color combination to use for the text and
background
the safest choice is to use black text on white background.
Background:
After you have chosen an appropriate background for your
slides
stickto your choice and use the same background throughout the
presentation
particularly for scientific presentations, a plain background is preferred
(a gradient of the shades of the same color is also acceptable).
If you are inclined to add graphic, picture, in your
background
make sure that it is subject appropriate and
does not draw attention away from the text and figures that you
are attempting to communicate.
Simplify the tables so that you only have a few columns and/or
rows.
If need be, breakdown your table into bite-sized snippets that the
audience can absorb and digest.
graphs, drawings or pictures in a slide page should be large
enough to be clearly viewed
Should be well labeled
variables on both axes scaled and clearly shown with units.
Appropriate coloring for sharp contrast with background and other
content in the slide.
If need be (for comparison), may be a few multiple of them as far as
eligible
Errors
Major/Minor errors such as misspelled words, grammatical errors, punctuation
mistakes, etc.
Errors convey to the audience that you have not put in enough attention to your work.
The implication of errors is the audience will be skeptical about the soundness of the
work you are presenting.
If you did not pay attention to the material displayed in public, can you really be
trusted to pay due diligence during the actual conduct of the research?
Errors that you could have easily corrected in a few minutes will taint the entire
body of your work.
Avoid such errors at all cost
If your spelling and grammar is not up to par
you can always make use of the built-in spelling and grammar checker in the presentation
software
consult a friend or an advisor
Plan ahead
know the room; technical equipment…
Know the introduction by heart
Concentrate before your talk
Recall your main points
Speak freely (don’t read and don’t recite)
Dress right
Attitude/Style
Keep good time, Be enthusiastic, Be dramatic
Voice
Speak loudly and clearly, Avoid monotony
change volume, speed, rhythm, make pauses
Mannerism
Look at your audience, Keep eye contact, Move, but
don’t pace, Use gesture and body language