WRITING TECHNICAL DOCUMENTATION

±5 minutes required to read this course material

COURSE DURATION	:	1 DAYS (7 HOURS)
AWARD TYPE	:	CERTIFICATE OF COMPLETION
TOTAL COURSE FEES	:	RM 500 PER PARTICIPANT (HRDF CLAIMABLE)
VENUE	:	IN-HOUSE (CLIENT’S LOCATION)
MIN/MAX PARTICIPNTS	:	MINIMUM 3 PARTICIPANTS, MAXIMUM 15 PARTICIPANTS

RATIONALITY OF THIS TRAINING COURSE

1. Why we write technical documents
2. Types of technical documents
3. Planning and designing document flow
4. Teaching & instructional language methods
5. Interpret and analyse data effectively
6. Using appropriate technical  language in writing
7. Learn modern methods of presenting information
8. Write a complete technical document in its correct format

WHO SHOULD ATTEND

Technician level and junior engineers who read technical documents or contribute their knowledge towards others preparing technical documents or would themselves be interested to produce technical documents in their line of work.

A person without prior knowledge of preparation or reading technical documents; or a person who reads and now would like to know the process involved in making technical documents.

LEARNING OUTCOMES

Critically review knowledge to be transferred  and communicate the results through technical document format to specialist and/or non-specialist audiences.

Demonstrate a sound understanding of technical writing skill, usage of images and diagrams to convey the necessary information to the targeted audience.

Organise Information in useful manner, both for future referencing and distribution

Trainer and Course Introduction

1. The trainer
2. The ‘WHY’ of Technical Documentation
3. The types of Technical Documents
4. Nature and characteristics of a research needed in writing

Information and Data Collection Analysis

1. Workflow/process or Standard Operating Procedures as source of information
2. Existing/known data  on prior knowledge of subject-matter
3. Data from experiments/tests  & sampling methods
4. Data collection by interviews, questionnaires, observation
5. Data analysis of qualitative and quantitative information

Document Flow and Design

1. Main aim of the technical document
2. Identifying problem
3. Giving weightage to the problems
4. Formulating solutions for the problems
5. practicalities of design
6. Sustainability and ethical issues
7. [if required] Referencing conventions such as the Harvard system, numeric system

Planning and Outlining

1. Technical language used in writing
2. Mechanics of writing
3. Procedure for citations and quotes

Developing and Structuring the Document

1. Sequence of events: alphabetical or numerical or chronological process order
2. Division of document : Sections/Divisions/Parts/Chapters
3. Other sections of a document (based on necessity/requirements)

a)    synopsis

b)    preamble

c)    abstract

d)    acknowledgement

e)    table of contents

f)     appendices

g)    bibliography

h)   Safety WARNINGS       

i)     Editing and revising drafts  

j)     Technical document versioning and revisions

for HRDF registered companies/individual.