Technical Report Writing Lecture Notes-1 - 156
Technical Report Writing Lecture Notes-1 - 156
MANDATORY
AND
NON-MANDATORY COURSE
MANDATORY AND NON‐MANDATORY COURSE
PRE - TEST
TECHNICAL REPORT WRITING
INTRODUCTION TO COURSE
INTRODUCTION TO COURSE
COURSE’S PURPOSE
COURSE’S TARGET
COURSE OFFERS
COURSE CONTENTS
COURSE CONTENTS
1.0 INTRODUCTION
2.0 PURPOSE IN WRITING TECHNICAL REPORT
3.0 AUDIENCES OF TECHNICAL REPORT
4.0 TECHNICAL REPORTS
5.0 TYPE OF TECHNICAL REPORT
6.0 TYPICAL COMPONENT OR CONTENT OF
TECHNICAL REPORTS
7.0 GENERAL FORMAT OF TECHNICAL REPORT
8.0 TECHNICAL REPORT’S CONTENTS
9.0 REPORT’S LAYOUT
10.0 SHORT REPORTS - ROUTINE TECHNICAL
DOCUMENTS
INTRODUCTION TO COURSE (Continue)
COURSE’S SCHEDULE
COURSE’S SCHEDULE
DAY 1
TIME 08.30 10.00 10.30 13.00 14.00 15.30 15.45
– – – – – – –
10.00 10.30 13.00 14.00 15.30 15.45 17.00
ACTIVITY Pre-Test Morning Topic 2–3 Lunch Topic 4–5 Evening Topic 6–7
Topic 1 Tea Exercise 1 Break Tea Exercise 2
Break Break
DAY 2
TIME 08.30 10.00 10.30 13.00 14.00 15.30 15.45
– – – – – – –
10.00 10.30 13.00 14.00 15.30 15.45 17.00
REPORT’S AUDIENCE
REPORT’S AUDIENCE
DEFINITION OF AUDIENCE
DEFINITION OF AUDIENCE
AUDIENCE
An Audience Is A Group Of Readers Who Reads A
Particular Piece Of Writing
EXAMPLES OF AUDIENCE
Your Superior, Colleague,
Station Superintendent, President Of An
Organization,
A Management Staff, Or Any Others
(To Be Continued)
REPORT’S AUDIENCE (Continue)
TYPES OF AUDIENCE
TYPES OF AUDIENCE (Continue)
TYPES OF AUDIENCE
Some Writer Categories Audience As
1. Technical
2. Non-Technical
Other Writer Categories Audience As
1. “Lay” Audience
2. “Managerial” Audience
3. “Experts” Audience
REPORT’S AUDIENCE (Continue)
EVALUATION ON AUDIENCE
EVALUATION ON AUDIENCE
PURPOSE OF WRITING
PURPOSE OF WRITING
DEFINITION OF PURPOSE
DEFINITION OF PURPOSE (Continue)
PURPOSE
• Aim Or Goal Of The Writer Or Written Product
• Reason Why You Are Writing
(To Be Continued)
PURPOSE OF WRITING (Continue)
TYPES OF PURPOSE
TYPES OF PURPOSE (Continue)
TYPES OF PURPOSE
EXAMPLES OF PURPOSE
EXAMPLES OF PURPOSE (Continue)
EXAMPLES
• To List Down What Need To Buy Or Activities
• To Describe A Chemistry Experiment Or Project
• To List To Explore, Inform Or Explain An Idea
• To Argue For Or Against An Idea In Evaluating
Problems
• To discuss In Problem Solving
(To Be Continued)
PURPOSE OF WRITING (Continue)
(To Be Continued)
PURPOSE OF WRITING (Continue)
WRITING STRATEGY
DEFINITION AND STRATEGIES (Continue)
TECHNICAL REPORTS
TECHNICAL REPORTS
REPORTS
• Many Report Types Categories As Technical Reports
Which Include Various Types Of "Technical" Information;
Information Need To Convey To Audience
EXAMPLES
DEFINITION OF TECHNICAL
REPORT
DEFINITION OF TECHNICAL REPORT
REPORT TYPES
1. Research Findings / Primary Research
2. Technical Background / Technical Information
3. Technical Specifications
4. Technical Evaluation / Feasibility
5. Technical Recommendation
6. Evaluation, Feasibility And Recommendation
(Combination)
(To Be Continued)
TYPES OF TECHNICAL REPORT (Continue)
REPORT TYPES
7. Report-Length Proposal / Documentation Proposal
8. Technical Manuals And Instructions
9. Organizational Policies And Procedures.
10. Business Prospectus
11. Business Plan
(To Be Continued)
TECHNICAL REPORT
REPORT’S CONTENTS
REPORT’S CONTENTS
TECHNICAL SPECIFICATION
Consist Of Descriptions & Discussion Of
Construction, Materials, Functions, Features, Uses
And Workings (Operational Details) Of New
Product Such As Tool Or Equipment Being Design
In Or Recommended To Be Bought
Not Much In Writing But Can Be Written A More
High-Level Version
Concentrate On Graphics, Data In Tables & Lists,
Illustrations.
(To Be Continued)
REPORT’S CONTENTS (Continue)
(To Be Continued)
REPORT’S CONTENTS (Continue)
TECHNICAL RECOMMENDATION
Compares Two Or More Alternatives &
Recommends One (Or, If Necessary, None).
Builds On Evaluation & Feasibility Reports & Comes
To Specific Recommendations To Help Decision-
Maker Adopt The Best Solution
(To Be Continued)
REPORT’S CONTENTS (Continue)
DOCUMENTATION PROPOSAL
A Proposal With Most Of Characteristics Of A
Proposal, With Additional Characteristics That
Enable To Achieve Primary Objective - Getting
Contract Or Getting Approval To Do Project
Internal - Within Company, To Write Proposals To
Establish The Need For New Equipments / Tools
External - External Company, To write proposals to get
contracts For Service / Supply
(To Be Continued)
REPORT’S CONTENTS (Continue)
(To Be Continued)
6.0 TECHNICAL REPORT
EXAMPLES OF REPORT’S
TYPICAL COMPONENTS
REPORT’S COMPONENTS
1. Introduction
2. Problem, Background
3. Purpose, Objectives, Scope
4. Review Of Literature
5. Materials, Equipment, Facilities
6. Theory, Methods, Procedures
7. Results, Findings, Data
8. Discussion, Conclusions, Recommendations
9. Bibliography
(To Be Continued)
REPORT’S COMPONENTS (Continue)
1. Definitions 8. Comparisons
2. Causes 9. Applications
3. TECHNICAL SPECIFICATIONS
1. General Description
2. Part-By-Part Description
3. General-To-Specific Order
4. Graphics, Tables (Or Lists)
(To Be Continued)
REPORT’S COMPONENTS (Continue)
4. DOCUMENTATION PROPOSALS
1. Introduction 7. Development And Media Tools
(To Be Continued)
7.0 TECHNICAL REPORT WRITING
TECHNICAL REPORT’S
GENERAL FORMAT
GENERAL FORMAT
(To Be Continued)
GENERAL FORMAT (Continue)
LOGICAL STRUCTURE
INTRODUCTION
TECHNICAL DETAIL
RESULTS
‘STANDARD MODEL’
‘STANDARD MODEL’
‘STANDARD MODEL’
(To Be Continued)
‘STANDARD MODEL’
MAIN FEATURES
MAIN FEATURES
REQUIRED SECTIONS
REQUIRED SECTIONS
9. ‘Conclusion’
10. ‘Recommendations’
11. ‘References’ And/Or ‘Bibliography’
12. ‘Appendices’
WHY?
1. Reader Will Know What To Expect Each Section,
Quick Referring
2. Find Clear Section Divisions Useful In Understanding
3. Help New Writer Thoughts When Writing
TECHNICAL REPORTS
ALTERNATIVES TO
STANDARD MODEL
ALTERNATIVES TO STANDARD MODEL
TECHNICAL REPORT’S
CONTENTS
TECHNICAL REPORT’S CONTENTS
REPORT’S CONTENTS
DETAILS
REPORT CONTENT’S DETAILS
TITLE PAGE
(To Be Continued)
REPORT CONTENT’S DETAILS (Continue)
ABSTRACT OR SUMMARY
EXECUTIVE SUMMARY
A Short Version & Guide To Report That Written For
Readers Who Do Not Have Time To Read Entire Report
Should Provide Information Such As Indicate Scope &
Main Results & Conclusions, Not Just Description Of
Report
Must Be Clear, Logic & Understandable Without The Rest
Of Report
Some Reports Only Include An Abstract While Others
Include An Executive Summary
(To Be Continued)
REPORT CONTENT’S DETAILS (Continue)
REPORT’S BODY
(To Be Continued)
REPORT CONTENT’S DETAILS (Continue)
INTRODUCTION
Presents About Context, Sets Out What Report Is About &
What Its Role Related To Other Work In Field
In Experiments, - Summarize Other Related Experiments &
Show How Work To Be Described, Extends Or Supersedes
Earlier Studies
In Development - Set Out What Purpose Of Development,
Who Will Benefit & How Will Be Used
In Review - State Scope Of Report
In Investigation - State Clearly What Investigators Set Out
To Find
(To Be Continued)
DETAILS OF REPORT’S BODY (Continue)
THEORETICAL BACKGROUND
Refer To Type Of Technical Report - Technical
Background Report Or Technical Information Report
OBJECTIVE
States What Work Being Reported Was Expected To
Achieve, Why It Was Undertaken & At Whose
Initiation Usually Preferably At End Of Introduction
(To Be Continued)
DETAILS OF REPORT’S BODY (Continue)
THEORY / EQUATION
Describes Any Background Theory Needed For The
Reader To Understand The Report
Usually Found Only In Reports That Use
Mathematics Such As Equations That The Typical
Reader Cannot Be Expected To Know In Advance
(To Be Continued)
DETAILS OF REPORT’S BODY (Continue)
RESULTS OR FINDINGS
DISCUSSION
Combined With "Results Or Findings" Into One
"Results/Findings & Discussion" Section
Provides Interpretation Of Results Or Findings, Compares
With Other Published Findings Or Manuals & Points Out Any
Potential Shortcomings In Work
Place Where Writer Allows To Be Less Objective Than Usual -
Acceptable To Mention Opinions, & Speculate Slightly About
Significance Of Work
If Findings Are Unusual Or Odds With Other People's
Conclusions - Explain Why This Might Be
(To Be Continued)
DETAILS OF REPORT’S BODY (Continue)
CONCLUSIONS
Conclusions Must Conclude!
RECOMMENDATIONS
(To Be Continued)
REPORT CONTENT’S DETAILS (Continue)
‘REFERENCES’ VS ‘BIBLIOGRAPHY’
ACKNOWLEDGEMENTS
TECHNICAL REPORT’S
LAYOUT
TECHNICAL REPORT’S LAYOUT
(To Be Continued)
SHORT REPORTS (Continue)
1. Purchase Recommendation
2. Recommendation And Feasibility Reports
3. Mechanism Description
4. Process Description
5. Progress Report
(To Be Continued)
SHORT REPORTS (Continue)
PROGRESS REPORT
PROGRESS REPORTS
(To Be Continued)
PROGRESS REPORTS (Continue)
TIME PERIODS
(To Be Continued)
PROGRESS REPORTS (Continue)
PROJECT TASKS
Practically Every Project Breaks Down Into Individual
Tasks, Example:
Project Individual Tasks
Selecting A Topic
(To Be Continued)
PROGRESS REPORTS (Continue)
REPORT TOPICS
Progress Report Can Also Be Organized According To Work
Done On Sections Of Final Report.
ORGANIZATIONAL PATTERNS
To Report Information In Progress Report, Combine
Two Of These Organizational Strategies; Time
Periods, Project Tasks & Report Topics
(To Be Continued)
PROGRESS REPORTS (Continue)
ORGANIZATIONAL PATTERNS
Progress report A
Example 1 Task 1 Work completed
Current work
Planned work
Task 2 Work completed
Current work
Planned work
Task 3 Work completed
Current work
Planned work (To Be Continued)
PROGRESS REPORTS (Continue)
ORGANIZATIONAL PATTERNS
Progress report B
Example 2 Work completed Task 1
Task 2
Task 3
Current work Task 1
Task 2
Task 3
Planned work Task 1
Task 2
Task 3 (To Be Continued)
PROGRESS REPORTS (Continue)
ORGANIZATIONAL PATTERNS
Progress report C
Example 3 Topic 1 Work completed
Current work
Planned work
Topic 2 Work completed
Current work
Planned work
Topic 3 Work completed
Current work
Planned work (To Be Continued)
PROGRESS REPORTS (Continue)
INTRODUCTION
The Introduction Can Contain The Following:
Purpose Of The Project
Specific Objectives Of The Project
Scope, Or Limits, Of The Project
Date Project Began; Date Project Scheduled To Be Completed
People Or Organization Working On Project
People Or Organization For Whom Project Is Being Done
Overview Of Contents Of The Progress Report
(To Be Continued)
PROGRESS REPORTS (Continue)
PROJECT DESCRIPTION
(To Be Continued)
PROGRESS REPORTS (Continue)
CONCLUSION
(To Be Continued)
PROGRESS REPORTS (Continue)
(To Be Continued)
PROGRESS REPORTS (Continue)
END OF PRESENTATION -
QUESTIONS AND ANSWERS
TECHNICAL REPORT WRITING
THANK YOU
TECHNICAL REPORT WRITING
COMPETENCY TEST