Course Description
The secret of good technical writing is to be able to describe complex technical concepts and ideas clearly and coherently so that both expert and non-expert audiences can understand and benefit from your writing.
This training course covers such topics as planning technical writing, authoring, and reviewing. It gives an in-depth overview of the practical sides of writing technical texts.
What Do Participants Learn?
- Approach A Technical Writing Project With Confidence
- Apply The Phases Of A Technical Writing Project To Your Working Environment
- Understand The Importance Of Creating A Document Layout
- Prepare A Document Structure
- Write Concise Technical Information
- Work In Collaboration With Technical Personnel, Subject Matter Experts, And Decision-makers
Who Should Attend?
Anyone who has been asked to write a technical publication for an organization; anyone who would like to understand the fundamentals of technical writing.
What Will the Learning Experience Include?
Phase: 1
Introduce
- Comprehensive pre-program activities include:
- Web-based information forms & surveys completed by attendee.
- Direct consultation with the attendee about the expectations.
- During the training, participants engage in data, activities, and conversations that lead to insight and knowledge.
- Participants learn from expert trainers who have both academic and business experiences.
- Highly applicable training content & instructive activities for adding depth to training topics.
- **A half-day site visit for integrating the experience & plan next steps. Opportunities to provide connections, ideas & support.
Phase: 2
Explore & Practice
Phase: 3
Apply
- Apply & sustain the learning experience by using this ongoing support:
- To ensure participant has new skills or behavior progress.
- Optional, fee-based mentoring & coaching with the trainer.
- Training materials & additional documents (e-books, pdf files, presentations and articles)
- Evaluate your training experience by giving us feedbacks and help us to reach our organizational goals.
- Participant's Evaluation
- Trainer's Evaluation
Phase: 4
EVALUATE
Section One: Defining Technical Writing
- The Need For A Technical Writing Product
- The Benefits Of Using Technical Writing Products
- The Types Of Technical Writing Products: What Works, What Doesn’t
- Understanding The Profession
- Overview Of The Project Phases
Section Two: Getting Started, The Planning Phase
- Defining The Objective Of The Technical Writing Product
- Assessing The Client Needs
- Assessing The Audience
- Choosing The Right Deliverable For The Environment/End Use
- Selecting The Authoring Tools To Develop The Technical Publication
- Establishing The Review And Approval Cycles With Your Client
- Determining The Work Methodology With The Team/Subject Matter Experts
Section Three: Authoring The Content, The Writing Phase
- Determining The Appropriate Technical Writing Style
- Understanding The Principles Of Technical Writing Rules
- Using The Organization’s Publishing Standards
- Researching And Analyzing Technical Information
- Designing The Document Layout (Style Sheet And Template)
- Using Plain Language
- Chunking Information
- Designing Illustrations And Graphics
- Applying The Principles To An Exercise
Section Four: Reviewing The Product, The Review, Testing Phase
- Performing A Peer Review
- Testing The Product
- Editing The Content
Section Five: Managing Technical Publications, The Finalizing, Releasing Phase
- Controlling Versions And Saving Files
- Finalizing The Product
- Approving The Product
- Publishing/Releasing The Product
- Communicating The Product Release