Technical writing needs to be as understandable as possible, and
more often than not, needs far less detail. Many
readers of technical reports, such as senior managers, may not fully understand
the technical jargon. When writing technical reports, the author must be able
to translate complex findings and analysis into a clear, easy to understand
report, to aid the reader in making effective decision.
During this program, delegates will practice writing language
that is clear and concise. Focus will be given to report format and content;
which will ensure that your report has a good structure and flow; making it
easier for the readers to comprehend.
- Understand the difference between technical report and business report
- Compare and Analyze different technical reports
- Understand the principles of clear and concise writing
- Develop effective communication with technical as well as non-technical staff at all levels – matching your content to your readers’ knowledge
- Learn how to keep information specific rather than general
- Explore techniques on how to collect, organize, Analyze and evaluate information
- Edit wordy phrases – using simple words rather than complex ones
- Keep technical terms to a minimum – avoiding jargon, acronyms and abbreviations
- Appreciate the importance of writing clear and concise formal reports, equipment manuals and other technical documentation
- Know how to use examples and illustrations
- Learn how to transfer technical information into graphs, flowcharts and tables
- Use good layout to draw attention to key technical information
Day One
Introduction
·
What
types of report do you write?
·
Different
types of technical reports
·
Characteristics
of technical reports
·
The
three stages of report writing: preparing, writing and
editing
·
Obstacles
in writing technical reports
Elements of technical
report writing
·
Factual
versus opinion
·
Logical
flow of writing
·
Results
of research
·
Terms
of reference
·
Writing
an introduction
Planning the report
·
Define
the purpose of the report
·
Addressing
the needs of different readers
·
What
do you want your readers to know, feel and do
·
Brainstorming
the topic
·
Determining
the scope of the report
Day Two
Layout of a report
·
The
benefits of a well-structured report
·
Structuring
complex information
·
Generic
frameworks
·
Writing
a beginning, middle and an end for your report
·
Bringing
technical writing to life – choosing the right style
·
Technical
report checklist
Writing the report
·
The
importance of drafting the report
·
Organizing
the information in chronological manner
·
Determining
style and format
Writing specialist
documents
·
Research
findings
·
Technical
specifications
·
Feasibility
reports
Presenting the report
·
Knowing
when and what to edit
·
The
technical document reading process
·
Proofreading
– demonstrating professional credibility
The foundation of our training is anchored in activity-based experiential learning. This methodology takes into consideration different learning and communication styles, and more importantly language and cultural differences. It is through active participation that the adoption and application of theory is expedited. Our training team pays careful attention to planning and designing effective instructional methods essential for the transfer of knowledge. It is the creative skill of our management trainers and consultants that reveal untapped skills of the delegates through:
- Group discussion
- Individual and syndicate activities
- Individual and group tasks
- Case studies
- Role plays
- Audio and video evaluation
- Action planning
- Experiential learning games
- Presentations
- Assessments