Ensure Your Technical Documents are Complete, Organized, Clear and Concise

Techniques For Technical Writing

Technical reports, executive summaries, e-learning modules, white papers, and more …

Technical writing needs to be clear, concise, and — most of all — “reader-centered” to be understood and make the necessary impact. Good technical writing takes the intended audience into consideration, clarifies confusing jargon, and presents only the necessary information – written in a way readers will understand. It might sound impossible, but this particular “technical ability” is a learned skill, like any other.

BRODY’s Techniques for Technical Writing teaches writers of technical documents how to distill the reams of information into understandable form — for technical or non-technical readers. This customized, practical workshop uses your organization’s own materials as significant content for the course.

Learning Outcomes:

Participants who complete this program will be better able to…

• Understand six responsibilities of a business/ technical writer
• Connect data with a business story
• Tailor a message based on stakeholder priorities
• Use a map to plan an effective message
• Use headings, bullet points & parallel sentence structure to assist busy readers
• Improve the clarity and readability of their writing on an ongoing basis
• Use the technique of “light-layered-and-linked” to serve the varying needs of readers of technical information
• Follow guidelines to create clear charts and graphs

Target Audience:

Technical experts and individual contributors — professionals at any level — who write technical information for use by others, inside or outside of organizations

Pre-Work:

Writing samples sent to BRODY trainer before program, to review and incorporate into classroom exercises (can remain anonymous).

Content:

• Apply the S.C.O.R.E. Method™ to write with less stress and more success
• Learn a powerful way to organize material — message mapping example
• Use technique of “light, layered and linked” to communicate complex technical info.
• Participate in exercises to structure and improve short sections of reports.
• Participate in a small group session to build a report for participants’ target audience
• Review guidelines for effective charts and graphs

Follow-Up Option:

We recommend optional one-on-one follow-up, which provides participants with individual attention. This coaching occurs four to eight weeks after the regular program, either in person or via e-mail. Follow-up coaching consists of one hour of intensive review of samples of participating individuals.

Materials:

Customized workbook and Write it Right: Business Writing for Results “mini” book by Marjorie Brody

We can help you write complete, organized, clear and concise technical documents — contact BRODY Pro at (215) 886-1688 to find out more about our technical writing course!