Experts in Change Adoption and Training
Duration 1-day workshop
Technical writing is sometimes defined as simplifying the complex.
Good technical writing results in relevant, useful and accurate information. Often technical writing is geared to a specifically targeted audience to enable this audience to undertake action in pursuit of a defined goal. It is different from business writing in that it is less descriptive and emotive and instead focuses on conveying precise information in the most accurate and easy-to-understand way.
Technical writers work together with editors, graphic designers and illustrators, document specialists, content managers, instructional designers, trainers and analysts to produce a variety of deliverables, including:
Technical writing follows a development lifecycle that often parallels the product development lifecycle of an organisation:
Identification of needs, audience(s), and scope → Planning → Research & content development → Testing/review and revision → Delivery/production → Evaluation and feedback → Disposition (revision, archiving or destruction).
This program focuses on the development and dissemination of technical content to address specific business goals. It is an immersive program where participants will practically apply the frameworks of technical writing in the training room. Participants can bring documents (if applicable) to the workshop to use as a learning experience.
This program, delivered by Glass Rock Solutions, is designed for technical subject matter experts or technical teams involved in designing and developing technical content for business audiences as well other subject matter experts within the organisation.
1. Preparation – Plan your Document
a. Determining goals and outcomes
b. Selecting appropriate media
c. Understanding the audience
– i. Language and tone
– ii. Conveying a clear message
d. Data gathering
– i. Gathering data and fact checking
– ii. Support, sign off and referencing
2. Writing – Wording, Layout and Design
a. Building a logical structure
b. Writing an executive summary
c. Using style guides
– i. Pagination
– ii. Dealing with widows and orphans
d. Determining effective messaging strategies
– i. Imagery and graphics
– ii. Step-by-step instructions
– iii. Storytelling
– iv. Referencing
– v. Appendices
3. Writing – Grammar and Punctuation
a. Sentence and paragraph structure and sequencing
c. Parallel structures
d. How to avoid common mistakes
e. Using your words efficiently
4. Reviewing – Proofreading
a. Effective drafting
b. Fundamentals of proofreading
– i. Readability
– ii. Grammar and spelling
– iii. Formatting and consistency
c. Using Microsoft Word to assist:
– i. Tracking changes
– ii. Watermarking
d. Using others to review
5. Finalise and Release your Document
a. Choosing the right dissemination channels
b. Gaining sign-off
c. Evaluate the effectiveness of your document
Please fill out the form below and someone from our team will be in touch within the next 48 hours to get your training started.
When Simone Heaperman, the program manager, picked up the phone to speak with Preetie Shehkkar at Glass Rock Solutions, she had much to address and set right.
Tata Consultancy Services, a global technology leader with 450,000 employees worldwide, expect the best from anyone who works for them.
When Stuart Freer came to Australia, he was recruited as the Director, IT Service Delivery and Infrastructure, at the University of New South Wales.
Level 23, Collins Square Tower 5
727 Collins Street,
Melbourne Victoria 3008
Australia Square, Level 33
264 George Street,
Sydney NSW 2000
We acknowledge the First Australians as the traditional custodians of this continent. We pay our respect to the elders of the community, past, present and future.