AE-5491 TECHNICAL REPORT WRITING & RESEARCH

METHODOLOGY (03 Credit Hours)

By
Dr. Muhammad Ajmal
Associate Professor, Agricultural Engineering Department
University of Engineering & Technology, Peshawar

1
 Course and Classroom Information
❑ Overview
✓ This class will officially be operated by English lectures, computer-based exercises
focusing developing a practical approach to make the students capable of writing a
research paper using different tools for smooth record tracking and organization of their
intended task
❑ Teacher: Dr. Muhammad Ajmal [Cell#: 0333-9442921]
✓ E-mail: engr_ajmal@uetpeshawar.edu.pk, ajmal1075@gmail.com
❑ Class Time/Classroom: Friday (03:00-6:00 PM), Online Google Classroom/Agri. Engg.
Comp. Lab.
❑ Grading: Exams(Mid Term 25%, Final Term 40%), Homework/Discussion &
Presentations (15%) + Research Proposal and Review Paper (20%)
❑ Homework Breakup

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 2

 Course and Classroom Information
❑ Overview

➢ Research Proposal starts by developing an idea based on literature review in any field of

interest intended for your major research or mini project as: introduction, objectives, study

area, rational (methodology), results and discussion, and conclusions.

❑ Teaching materials, other references, and announcements etc. will be communicated

through Google Classroom or Google group to all students.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 3

 Course Contents
 Basics of technical writing process, Technical writing techniques and applications
 Definition and basics of research, Research purpose
 Design of research methods Identification of research problem
 EndNote 9x Installation and Application as Citation and References Manager
 Literature review, Selection of data collection techniques, Selection of representative
sample
 Writing of research proposals
 Data collection and analysis techniques
 Limitations and significance of research techniques
 Quantitative and qualitative research procedures
 Writing of research reports
 Presentation skills, and oral presentations

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 4

Recommended/Reference Books

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 5

Recommended/Reference Books

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 6

Recommended/Reference Books

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 7

 Recommended/Reference Books
1. Laplante, P.A. (2018). Technical Writing: A Practical Guide for Engineers, Scientists, and Nontechnical
Professionals. CRC Press, New York, USA.
2. Alred, G., Brusaw, C. and Oliu, W. (2012). Handbook of Technical Writing, 10th Edition. St. Martin's Press, Boston,
USA.
3. Rubins, P. (2002). Science and Technical Writing: A Manual of Style (Routledge Study Guides) 2nd Edition,
Routledge, New York, USA.
4. Smith-Worthington, D., and Jefferson, S. (2010). Technical writing for success. Cengage Learning, South-Western
Cengage Learning, Mason, USA.
5. Budinski, K.G. (2001). Engineers' Guide to Technical Writing. ASM International, Materials Park, USA.
6. Pruzan, P. (2016). Research Methodology: The Aims, Practices and Ethics of Science, Springer International
Publishing, Switzerland.
7. Bairagi V and Munot M.V. (2019). Research Methodology: A Practical and Scientific Approach 1st Edition,
Chapman and Hall/CRC, India.
8. Kothari, C.R. (2013). Research Methodology 3rd Edition, New Age International Pvt Ltd Publishers, New Delhi,
India.
9. Deb, D., Dey, R., and Balas, V.E. (2018). Engineering Research Methodology: A Practical Insight for Researchers
(Vol. 153). Springer, UK.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 8

 Research Paper (20% Marks)
⚫ A Roadmap Towards Making Research Proposal & Review Paper
 Choose a Topic of Your Interest
 Read Papers/Scientific Articles
 Write Introduction Citing different References
 Find a Research Gap
 Set your Objectives
 Select a Study Area
 Find Data and Screen it to Make it in Good Workable Condition
 Develop Rational (Methodology/Material and Methods)
 Results and Discussion
 Conclusions (Also mention limitations/weak areas of your study)
 List of References (Use EndNote)

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 9

 Think for a Moment

What do You Know about Technical

Report Writing
[20 Min Discussion]
Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 10
Basics of Technical Writing Process

11
 Quotes: Problem and Solution

❑ If there is a Problem that can be Analyzed one can find way for its Solution
ALLAH promises ease after every hardship

"A problem clearly stated is a problem half solved.”

Dorothea Brande
"You are either part of the solution or part of the problem."
Eldridge Cleaver
"When you can't solve the problem, manage it."
Robert H. Schuller
"Each success only buys an admission ticket to a more difficult problem."
Henry Kissinger
"The man who has no more problems to solve, is out of the game."
Elbert Hubbard
12
 Guidelines
for
Technical Writing

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 13

 General Issues
Why to learn about writing?
Surely, any literate can write. Why talk about ‘Writing’?
Any body can sing. But, can we get an audience?
Writing is for communication? Can we get readers?

‘Writing’ is a SKILL.
Good writing is an ART. More so ‘Technical Writing’.
There may be those who are born or gifted writers.
Others have to LEARN and PRACTICE.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 14

 Contents
❑ Introduction
❑ General Issues
❑ Basic Requirements
❑ Elements of Technical Writing
❑ Writing a Project Report
❖ Selecting a Project – Composing the Title - Writing the Introduction – Body
of the Report – Problem – Methodology and Tools – Collecting the Results –
Presentation of the Results – Conclusions and Recommendations – Abstract
– Appendix
❑ Where is the Innovation?
❑ General Hints on How to Study

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar

15
 Introduction

Scope: Presentation of broad guidelines on writing a project report.

Purpose: Help the students who have to do lot of technical writing.
Assignment Reports
Examinations
Project Reports
Plan: General Issues – Elements of Technical Writing – Technical Report
Writing.

16
Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar
“Practice is the best of all instructors.”
Publilius Syrus
Syrian-born Roman author, c. 100 BC

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 17

Purpose

Provide an opportunity to develop the writing skills.

Assignment Convey the ability to analyze a problem.

Exam Ready to use knowledge plus ability to be precise

Project Report Physics of the problem and its application –

Critical view - design/analysis process
Results – conclusions
Oral and Written presentation.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 18

 Why Technical Writing?
• Build on existing knowledge
• Propagate the knowledge
➢ Project mates/Co-workers/Team members
➢ Sales/Marketing personnel
➢ Customers

Technical Work is NOT Technical Writing

Commitment & Details

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 19
 Basic Requirements
Technical writing is a specialized field that requires
❑ Personal Discipline
❑ Organization Skill

❑ Skill in Writing Clearly and Concisely

❑ Understanding of Technical Products and Processes

❑ Knowledge of numerous software tools

Good Vs Bad writing: This is subjective. No one is perfect.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 20

 Organization
❑ What are you writing about?
❑ What do you plan to achieve in what you are writing?

Ideas

Flow
Hierarchy

Refinement

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 21

 Audience

❑ Who is going to read the report?

❑ What is the level of their current knowledge?

❑ How much information is needed?

❑ What background information to include?

❑ Why is the reader reading the report?

❑ Is the document supposed to inform or convince?

❑ How much time does the reader have to read it?

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 22

 What is Technical Writing?

❑ TECHNICAL WRITING is a broad term that encompasses a wide variety of

documents in science, engineering, and the skilled trades. The major types of
documents in technical writing can be grouped into four major categories:

❖ Reports and communications in day-to-day business

❖ Technical papers, magazine articles, books, and theses for purposes of
education, teaching, and sharing of information and knowledge
❖ Patents
❖ Operational manuals, instructions, or procedures

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar

23
Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar
24
 Basics of Technical Writing Process
❑ “The fundamental purpose of scientific discourse is not the mere
presentation of information and thought but rather its actual
communication. It does not matter how pleased an author might be to have
converted all the right data into sentences and paragraphs; it matters only
whether a large majority of the reading audience accurately perceives what
the author had in mind.”
❑ “Therefore, in order to understand how best to improve writing, we would do
well to understand better how readers go about reading. Such an understanding
has recently become available through work done in the fields of rhetoric,
linguistics and cognitive psychology. It has helped to produce a methodology
based on the concept of reader expectations.”
George Gopen and Judith Swan

George D. Gopen and Judith A. Swan (1990). The Science of Scientific Writing, Vol. 78,pp. 550-558
25
Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar
 Basics of Technical Writing Process
 For Technical Writing, there is no universally accepted definition. Many
authors discuss the difficulties in defining “technical writing” and then offer
their own definition.

 Whether digital, face-to-face, handwritten, or printed, workplace

communication is more than a value-neutral exercise in “information transfer”
and is a complex social transaction.

 From job applications to email messages, video chats to oral presentations,

reports to proposals, every rhetorical situation has its own specific interpersonal,
ethical, legal, and cultural demands.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar

26
 Basics of Technical Writing Process
 Today's professional needs to be a skilled communicator and a
discriminating consumer of the information, skilled in methods of inquiry,
retrieval, evaluation, and interpretation essential to informed decision
making.

 One can find responses to these issues in Technical Communication.

 The purpose of a technical report is to communicate. You wish to

communicate what you did, why you did it and what you have found out.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 27

 Basics of Technical Writing Process
 Technical writing is the presentation and communication of accurate and
objective, scientific and technologic information, ideas, or procedures.

OR

 Technical writing or communication is, “The process of creating, designing and

transmitting technical information so that people can understand it easily and
use it safely, effectively and efficiently.” (Markel 1998)

 Technical communication is read by people who need to carry out procedures

and solve problems.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 28

 Basics of Technical Writing Process
Who creates Technical Communication?
 Technical Professionals e.g. Engineers, scientists, business people etc.

 According to one survey carried out in the US, Technical Professionals can
expect to devote at least one-fifth of their time to writing (Anderson, 1985).

֎ Engineers can expect to spend 40% of their time for writing (Beer and
McMurrey, 1997).

֎ Supervisors spend 40% of their time reading and writing.

֎ Managers spend 50% of their time undertaking the above activities.

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 29

Basics of Technical Writing Process

Brainstorming Planning

Analysis

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 30

Basics of Technical Writing Process

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 31

Basics of Technical Writing Process

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 32

 Characteristics of Technical Communication/Writing
 Technical writing is done with a singular style and format that describes:
❖ Why you are doing the work (introduction)
❖ What you did (procedure)
❖ What happened (results)
❖ What it means (discussion)
❖ What was learned (conclusions)
❖ What is to be done with the results (recommendations)

Engineer’s Guide to Technical Writing

(Budinski, 2001)
33

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar

 Characteristics of Technical Communication/Writing
❑ Technical writing
❖ Addresses particular readers
❖ Helps readers solve problems
❖ Furthers an organization’s goals
❖ Is created collaboratively
❖ Uses design to increase readability
❖ Involves words and graphics
❖ Involves high-tech tools.
Technical Communication
(Markel,1998)

34

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar

 The Nature of Technical Writing
 Technical writing is a specialty within a field of writing – writers must learn proper
writing skills, variations in format, clear objectives
◆ Technical writing characterized by :
⚫ Clarity

⚫ Conciseness

⚫ Accuracy

⚫ Organization

⚫ Ethics

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 35

 The Nature of Technical Writing

❑ Some factors to keep in mind regarding technical writing

Technical Writing
 communicates issues in engineering and the sciences.
 has form and style requirements that are different from those of other types of writing.
Reports need to include definite elements.
 does not employ humor or slang/jargon.
 is objective oriented.
 does not blame people.
 requires facts or data and never hide facts.
 deals with non-administrative issues.
 is never used as advertising copy.
 is impersonal—it does not use personal pronouns or people names who performed parts
of the work. Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 36
 Important Articles for Supplementary Reading
1. Honing the Writing Skills of Engineers
https://ascelibrary.org/doi/abs/10.1061/(ASCE)1052-3928(1996)122:3(107)
2. How Technical Communication Textbooks Fail Engineering Students
https://www.tandfonline.com/doi/abs/10.1080/10572250903149662
3. Four Effective Writing Strategies for Engineering Classes
https://onlinelibrary.wiley.com/doi/abs/10.1002/j.2168-9830.1999.tb00411.x
4. Communication Skills for the 21st Century Engineer
https://www.semanticscholar.org/paper/Communication-Skills-for-the-21-st-Century-
Engineer-Riemer
5. The Wit-Learning Methodology as a Means for Research Skills Acquisition: A Longitudinal Assessment
https://www.igi-global.com/chapter/the-wit-learning-methodology-as-a-means-for-research-skills-
acquisition/237248
6. Improving engineering students’ writing/presentation skills using laboratory/mini-project report
https://journals.sagepub.com/doi/abs/10.1177/0020720919833051

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 37

 Questions

Dr. Muhammad Ajmal, Associate Professor, Agri. Engg. UET Peshawar 38