Technical Report Writing and Presentations Study Notes

TECHNICAL REPORT WRITING AND PRESENTATIONS

Page 1

1. Introduction
   • Adepeju Adefisola Bola, PhD, BSc, MSc (OAU) at the Federal University Oye Ekiti, Ekiti State, Nigeria

Page 2

1.0 MODULE 1: INTRODUCTION TO TECHNICAL REPORT WRITING

1.1 LEARNING OUTCOMES

• Understand the meaning of technical report writing.

1.2 Introduction

• Common Misconception: Science and engineering tasks are often perceived to involve only machinery and test tubes. However, writing is integral in these fields.
• Definition of Technical Report: A formal document to convey technical information clearly and accessibly. It includes various sections to cater to different readers. A technical report documents scientific and engineering activities.
• Importance of Clear Writing: The ability to write clearly and professionally is essential for scientists and engineers. They should convey complex ideas into understandable forms.
• Variations: Report formats can vary widely across different groups. This module presents a standard framework for technical reports, integrating common elements found across science and engineering writings.

Page 3

Key Components of a Technical Report

• A technical report should cover:
  • Reasons for conducting the work.
  • Means employed in the process.
  • Results obtained.
  • Conclusions drawn from the findings.

Experimental Details

• Essential for reports centered on experimental work.
• Information to Include:
  a. Equipment Used: Name and model of equipment (e.g., Instron universal testing machine Model 4300).
  b. Testing Conditions: Environmental conditions applicable to the experiment, supported by figures.
  c. Testing Parameters: A test matrix showing parameters used in experiments.
• Example:
  • Table 1.0: Matrix on the production of orange juice.

Page 4

Testing Parameters Example

• Table 1.0: Tests on orange juice production

  Trial	Parameter 1	Parameter 2	Parameter 3
  1	1.2	10	72
  2	2.8	20	68
  3	4.0	15	70

• Changes in Parameters: List in a tabular format if modified during experiments.

Characteristics of Technical Writing

• Governed by specific rules and a formal tone; characterized by the use of simple and familiar language rather than ornate expressions.
• Impersonal and objective; does not appeal to emotions.

Page 5

The Importance of Writing

• Used to communicate essential information for informed decision-making in business.
• Many professionals spend 1/3 to 1/2 of their time on technical writing, which includes:
  • Proposals
  • Regulations
  • Manuals
  • Procedures
  • Reports (Technical, Progress)
  • Emails and Memos

Pitfalls of Poor Writing

• Ineffective writing creates doubts about a writer's competence and can hinder career progression.

Technical Writing Excludes:

• Forms of entertainment, suspense creation, and inviting varied interpretations.
• Definition of Expository: Writing that aims to explain or clarify.

Page 6

1.3 Self-Assessment Questions

1. Describe a technical report.
2. Note components for the experimental details section.
3. Explain the importance of technical writing.
4. Enumerate types of technical writing.

1.4 Suggested Reading

• Ogedengbe M.O., et al. (2005). Technical Report Writing. Macmillan Nigeria.

Page 7

2.0 MODULE 2: PROPER REPORT WRITING

2.1 LEARNING OUTCOMES

• Learn proper report writing techniques.

2.2 Common Writing Deficiencies

1. Proper Name Formatting: Difficulty identifying surnames when written in full due to lack of guidance in forms. Surnames can be either the first or last name, depending on the written format.

• Examples:
  • Adeoya Olufunso Adeola
  • Yusuf Emmanuel Iyiola
  • Ogunware Andrew Adeleke
• General Guide: Accept the first name written with a comma as the surname if clearly indicated.

Page 8

2. Surname Identification:

• Examples with Commas and Capitalization indicating surnames.
• Avoid truncating names in formal settings (e.g., Adepeju should not be shortened to Peju).

2. Introduction with Titles

• Structure introductions with titles leading.
  • Example: “I am Prof. Ajoke Babalola.”
• Do not mix name formats.

2.3 Spelling Errors

• Common spelling mistakes include:
  • Tittle (for title)
  • Litrature (for literature)
  • Profession (for profession)
  • References (for references)
• Suggested mitigation: Use spell check features.

Page 9

2.4 Self-Assessment Questions

1. Importance of distinguishable surnames?
2. How do you present your name in full?
3. Write an introduction including your title.

Page 10

3.0 MODULE 3: STANDARD REPORT FORMATS

3.1 LEARNING OUTCOMES

• Identify standard report formats.

3.2 Technical Reports

• A method to communicate technical information for various stakeholders (e.g., customers, managers).
• Governed by ANSI standards (ANSI/NISO Z39.18-1995) to ensure uniform layout and presentation.
• Analogy: Like newspapers, technical reports allow quick location reading.

Page 11

Report Layout and Format

1. Report Layout: Overall presentation and structure, from the front cover to back cover.

   • Includes preface, body, appendix, and binding.

2. Prefatory Section:

   • Contains Title Page, Table of Contents, Lists of Figures/Tables.
   • Abstract or summary is often included.
   • Importance of the Table of Contents for structure examination.

Page 12

3. Body of the Report includes:

   • Introduction, Literature Review, Methods, Results, and Discussions.

4. Appendix Section: Additional information that may not fit in the main report body but is necessary for understanding.

5. Report Binding: Enhances durability and presentation, can be soft or hard-bound.

Page 13

Mechanical Accuracy

1. Paper Sizes: Various sizes (e.g., quarto, A4, foolscap) and colors (white, blue, green) are used in formal writing.

2. Margins: Specific margins (left, right, top, bottom) should be adhered to:

   • Left: 38mm
   • Right, Top, Bottom: 25mm

3. Spacing and Indenting:

   • Double-spacing is the norm, with different standards for various document sections (e.g., single space for footnotes).
   • Indentation of paragraphs is typically five spaces.

4. Paging: Necessary pagination methods for prefatory (Roman numerals) and main body using Arabic numerals.

Page 14

Footnoting

• Notes providing references, explanations, or comments at the bottom of the text; structured disposal of these in accordance with margin rules.

3.3 Self-Assessment Questions

1. Describe Technical Report?
2. Outline Report Layout.
3. Explain sections of a report.

3.4 Suggested Readings

• Ogedengbe M.O., et al. (2005) Continued.

Page 15

4.0 MODULE 4: USAGE OF ABBREVIATIONS, NUMBERS, PUNCTUATION, AND CAPITALIZATION

4.1 LEARNING OUTCOMES

• Identify elements for proper report formatting.

4.2 Usage of Abbreviations

• Abbreviations should be used when clear to the reader; non-complex terms should be spelled out.
• Abbreviations for measurement units should follow exact numbers (e.g., 10 g).

Page 16

Punctuation Principles

• Importance of correct punctuation, common errors to be aware of (e.g., misuse of commas, semicolons).

Page 17

Abbreviations Table

Page 18

Capital Letters

• Capitalization rules such as proper nouns, names of organizations, should be followed strictly. Errors must be avoided.

Page 19

4.3 Self-Assessment Questions

1. Summarize report format fundamentals presented in this module.
2. Define mechanical accuracy in report writing.

Suggested Readings

• Ogedengbe et al.

Page 20

5.0 MODULE 5: LITERATURE REFERENCING

5.1 LEARNING OUTCOMES

• Understand the purpose and methods of literature reference.

Page 21

Background

1. Importance of Literature Review: Essential for establishing the knowledge base for any new research project—ensures awareness of existing scholarship.

Page 22

Literature Citing

1. Purpose: To credit sources and enable verification.
2. Methods: Mention in-text citations using citation methods (Arabic numerals or Author-Year).

Page 23

Listing References

• Importance and structure of reference section. References may vary based on liquid errors but consistency is paramount.

Page 24

Sample Articles

1. Use of citation conventions is mandatory; examples demonstrated for proper formats.

Page 25

5.3 Self-Assessment Questions

1. Why use references in writing?
2. Identify major referencing styles that should be applied in reports.

Page 26

6.0 MODULE 6: STANDARD REPORT FORMATS

6.1 LEARNING OUTCOMES

• Recognize common formats used in technical reporting.

Page 27

Technical Report Layout

1. Front Cover: Information about the work.
2. Front Matter: Covers title page, abstract, etc.

Page 28

Back Matter

• Supplemental information necessary for context.
• May include appendices, bibliographies, glossary.

Page 29

7.0 MODULE 7: STANDARD REPORT FORMATS CONT’D

Listing Symbols and Abbreviations

• Clarification and organizational tools to aid reader comprehension.

Page 30

8.0 MODULE 8: STANDARD REPORT FORMATS CONT’D

Table of Contents

• Detailed content organization aids reader navigation through the report, leading sections with page numbers properly formatted.

Page 31

Self-Assessment Questions

• Demonstrate understanding of report layout principles and their execution.

Page 32

9.0 MODULE 9: STANDARD REPORT FORMATS

9.1 LEARNING OUTCOMES

• Familiarize oneself with practical applications and examples of different report types.

Page 33

Types of Reports

• Various reports: dissertations, journal papers, proposals, feasibility studies.

Page 34

Report Structure Elements

• Introduction, methods, findings, discussions, and recommendations identified for clarity.

Page 35

Self-Assessment Questions

1. What methods can you employ for effective report writing?
2. Discuss the functionality of lists in reporting.

Page 36

10.0 MODULE 10: MAIN ELEMENTS OF A REPORT

• Consistency: Maintaining a uniform format and style to enhance professional presentation.

Page 37

Self-Assessment Questions

1. The relevance of appendix sections.
2. Effective writing principles.

Page 38

Conclusion to Technical Report Writing

• Summation of significant points and reiteration on the importance of formality in technical writing, ensuring all elements are meticulously detail-oriented and formatted correctly.