New user? Register as member

1-Day Technical Writing Course

Successfully conveying technical content to end users of varying technical knowledge or minimum technical knowledge is vital and can greatly enhance the value of your products and services. The advancement of AI has made writing a lot easier and faster. This training course provides a complete process for putting together a comprehensible technical document with the help of AI.

Objective

By the end of this workshop, learners will be able to:

1. List the common errors in technical writing
2. Have an end in mind (who is the customer) for the document
3. Employ guided structure in technical writing
4. Write clear, accurate and convincing documents
5. Acquire practice in writing technical documents
6. Utilise AI in assisting in technical documents, including, e.g. structure, grammar and tone of writing
7. Discover strategies in Prompt Engineering
8. Understand and adopt ethical and responsible use of AI

Outline

1. Problems Faced by Technical Writers
- The workshop will discuss and surface some of the problems faced by technical writers.

2. What is the purpose of the technical report and what message are you trying to convey?
- Understand why we write technical report and how to ensure we have the target in mind when writing the report.

3. Who is your target audience? (customer)
- How to identify the target audience and why is it important to know this

4. Format and organisation for writing technical reports
- How to organise the report in a logical manner to ensure clarity and readability.
- Use of Graphics, tables and diagrams.

5. Guidelines for Better Writing
- How to build clarity through sentence focus and how to be concise and accurate.
- Common grammatical errors in technical writing.
- Proofreading of reports.

6. Introduce and hands on practices of utilising AI in assisting in technical documents, including, e.g. structure, grammar and tone of writing

7. Discover strategies in Prompt Engineering
- The different types of prompt and hands on practice in using the prompts

8. Understand the limitations of AI, the ethical concerns and responsible use of AI

9. Practise and Feedback
There will be exercises provided in workshop to allow practice and feedback.

Who should attend

This workshop will benefit all levels of engineers, technical staff and executives who need to write clear, convincing and accurate technical reports. It will also help anyone who is interested in understanding how AI can assist in improving productivity in technical writing. Although the course focusses on technical writing, the methodologies are also applicable to business writings.

Methodology

1. Presentation
2. Discussion
3. Exercises and practices
4. Feedback

Testimonials

I found the course content to be comprehensive and well-structured.

Greatly appreciated Agnes's expertise and passion for the subject, I learned a lot.

I feel more confident in my ability to apply the principles and techniques of technical writing in my professional development.

Good value in using it at company.

The activity is very interactive.

Ms Agnes is very knowledgeable and give good guidance.

Profile of Agnes Lim

Armed with a BSC (Hons) from the National University of Singapore, a MBA from the University of Hull and an Advanced Certificate for Training and Assessment (ACTA) by Institute of Adult learning (IAL), Agnes Lim has more than 30 years of corporate experience in the biomedical industry of which 20 years were in middle and senior management.

Adept at people management, she has more than 20 years experience in hiring, managing, training and developing staff and more than 10 years experience in succession planning at the site leadership level. She is able to connect with people across different levels in the organisation having worked up the levels in her career. She has conducted more than 300 interviews ranging from junior management staff to site leadership team members to scholarship aspirants at her previous companies.

Being in a technical department, Agnes is equally well versed in technical report writing and technical presentation, having created and reviewed many thousands of technical reports and presentations throughout her career.

Agnes has developed and conducted numerous trainings and coached learners on both technical and soft skills. Examples of trainings that she has conducted include, How Managers and supervisors can Develop Career of their Staff, Hire Right, Managing your Career Development for Success, Technical Writing Skills, Technical Presentation skills, Auditing Skills, Investigations Skills, Data Integrity, Quality Risk Assessments amongst others.

A comfortable and confident speaker, she was invited to speak at BioBiz at NUS previously to help the students have a better understanding of the career opportunities in the biomedical / pharmaceutical industry. She has also shared her educational choices with students at Raffles Girls School (Secondary), her alma mater.

Agnes is passionate about developing and cultivating talents within the organisation. She believes that a keen focus on talent development differentiates organisations and is a competitive advantage.

With a passion for youth and education, she currently volunteers with ACTS Singapore.