Technical Report Writing Training Course

Module 1: Introduction to Technical Report Writing

• Definition of a technical report
  – Parts of a technical report
  – Informal report
  – Uses of informal report
• Formal report
  – The component of a formal report
  – The concept of front material
  – Preparation of formal components
  – Format devices
• Informational and evaluation report
  – Data presentation
  – Suggestion
• Feasibility and recommendation reports
  – Arranging a recommendation report
  – Writing and presentation of the recommendation report

Module 2: Stages in Technical Report Writing 

• Technical writing applications
  – Memorandum format
  – Letter format
• Technical writing process
  – Pre-writing stage
  – Writing stage
  – Post-writing stage
• Report purposes
  – Technical problem statements
  – Rhetorical problem statements
• Data gathering
  – Previous reports
  – Data sources
  – Incomplete data
  – Excess perfection syndrome

Module 3: Effective Communication in Technical Report Writing

• Sentence clarity
• Clear paragraphs
• Clear organization
• Clear revision
• Reading clarity and comprehension
• Personal grooming

Module 4: Laws of a Good Technical Report

• Access to reports by readers
• Concise report
• Proper arrangement of information for readers
• Accurate referencing
• Straightforward writing style
• Design
• Cross-checking inconsistencies and errors

Module 5: Objectives of a Technical Report Writing 

• Identification of objectives
  – Who is the report for?
  – Why produce a report?
  – What information is covered
  – Readers’ knowledge of the subject matter
  – Details relevant to readers
  – The essence of a report to a reader
  – What is the expected response of a reader?
  – Bridging the gap between the present knowledge of a reader and what they ought to know
  – What level of formality is suitable?

Module 6: Format of a Technical Report 

• Appendices
• Sections and subsections
• Section headings
  – Title page
  – Acknowledgment
  – Summary
  – Table of contents
  – Scope of the report
  – Procedure
  – Results
  – Conclusion
  – Recommendation
• Notation
• References
  – In-text citation
  – Harvard referencing

Module 7: Writing a Technical Report

• Spelling
  – Avoid the wrong use of words
  – Technical word usage
  – Non-technical word usage
• Punctuation
  – Use of commas
  – Use of hyphens
• Sentences
• Paragraphs
• Formality
• Case study/example

Module 8: Textual/ Graphical Report Elements

• Textual report elements
  – Descriptive
  – Analytical
  – Comparative
  – Conclusive
  – Persuasive
  – Summary
• Graphical report elements
  – White space
  – Maps and aerial photographs
  – Graphs
  – Schematic and flow diagrams
  – Tables
  – Clutter
  – Color, line style, and weight
  – Next link and graphics

Module 9: Appearance Elements

• The concept of taste
• Simpler appearance
• Standard format
• Covers, bindings, and colors
• Tabs and dividers
• Large format maps and figures
• Fancy fonts
• Costs
• The custom report covers and tab sets

Module 10: Use of Diagrams in Technical Report Writing

• Diagram positioning
• Table Usage
  – Units and powers of ten in the column heading
  – Similar Group items
• Graphs
• Diagram referencing
• Diagrams checklist
  – Relevance
  – Easy to use
  – Attractive

Module 11: Audience Analysis in Technical Report Writing

• Primary audience
• Secondary audience
• Audience and the Use of your report
• Audience prejudice
• Audience functions and concerns
• Effect of a Report on Audience
• Time and money

Module 12: Technical Report Finishing

• Summary writing tips
  – Consider the word count
  – Provide background information
  – Highlight major findings
  – Employ continuous prose
• Abstract
• Table of content
• Title page
  – Title
  – Author’s name
  – Report reference number
  – Date
  – Classification
• Appearance
• Plagiarism checks
• Final check/submission