Other Options
Additional Internet Resources
Attendees's Comments
"Thank you for the excellent Writing Technical Documents training. You were very well prepared, well spoken, and professional in every aspect of the course. The workbook customization was right on target. One employee commented that your were "very personable and made potentially dry material interesting."
Introduction to Technical Writing
This seminar covers the writing skills necessary to produce technical documents. Participants will learn to put complex subjects in layperson's terms, describe involved processes and steps clearly, and write instructions that clarify rather than confuse.
Topics include:
- Selecting an appropriate format for the document
- Organizing technical material logically
- Preparing user-friendly instructions
- Using graphics to enhance technical information
- Zeroing in on your readers' needs
Seminar tips:
- Use no more than two typefaces per document. The viewer tends to become distracted when excessive typefaces compete with one another.
- Avoid underlining in technical documents because it visually distracts from the readers' ability to discern numbers and letters.
- Unjustified right margins are easier to read than justified margins and allow the reader to easily move from one line to the next.
Additional Versions of Technical Writing Training Available
Writing Technical Documents
This seminar is for anyone who writes technical documents. You will learn how to organize material by purpose and audience, define the elements of writing steps and procedures, and recognize the special terminology that technical writers must use for their audience. You will also learn how to improve the appearance of your technical documents and how to use key words and phrases correctly when writing conditional statements for procedures.
This class has numerous modules; these modules can be selected and customized to meet your specific needs:
- Reviewing the Basics
- Tips and Techniques to Start Writing
- Organizing Material by Purpose and Audience
- Writing with Greater Clarity and Precision
- Presenting Complex Information Simply
- Organizing Material for Procedure Writing
- Effective Wording for Conditional Statements
- Writing an Abstract
- Writing a Journal Article
- Writing White Papers
- Improving the Appearance of your Technical Document
After completing this class, you will be able to accomplish the following:
- Word instructions as positive statements
- Write procedures that are easy to follow
- Recognize and reach the different types of readers
- Simplify complex information
- Write conditional statements
You will also review basic principles of technical writing such as using good grammar, writing concisely, avoiding long sentences, and using standard punctuation.
Seminar tips:
- When writing procedures, be sure that the steps you tell your reader to take are clearly stated to avoid confusion. Each step must state the condition to be met. It must then identify the relationship between that condition and the action to be taken.
- Use the rules of formal logic to write conditional statements. The most important concept is to remember that the condition is always stated before the action. If the reverse were true, the user would most likely perform the action even if the condition had not been met.
- The conditional term NOT is used to highlight a negated condition. The word NOT is usually underlined in procedural writing to emphasize its importance. Always use NOT rather than negative prefixes such as “in” or “un.” Compare the following two statements:
- IF the fluid levels are NOT adequate, THEN adjust the flow valve.
- IF the fluid levels are inadequate, THEN adjust the flow valve.
- By using key terms consistently in procedural writing, you make it easy for the users to follow the steps and perform an action only if specific conditions are met.
Technical, Scientific, and Medical Writing: How to State Complex Ideas Simply
"The first and most important thing of all...is to strip language clean, to lay it bare down to the bone." - Ernest Hemingway
From technology to health care to business, writers must convey their message in a clear, accurate, and compelling way.
Translate complex technical, scientific, or medical knowledge and research into graceful, lucid prose that informs, entertains, and inspires your reader. Through clear, accurate writing--tailored for a specific audience--your communication will be understood and accepted.
Problem solving:
Complex Material? Flooded with facts and figures? Drowning in jargon? You'll discover how to make complex material transparent.
Diverse readership? Writing for both a general audience and experts, too? There is a way to serve both readers.
Don't know where to begin? Follow the simple formula for Three Steps to Writing on Demand and banish writer's block.
What's the story? Find the highest concept of any message and discover the difference it makes to your reader.
Illustrations-- -What works? What doesn't? Overwhelmed with graphics, tables and drawings and can't decide? Follow the guidelines major publications use.
Politics and publication? Turn your publication's critics into cheerleaders and watch them shepherd your prose into print.
Writing for the Web? Explore basic but important steps for adapting print features for online readers.
Who should attend?
- Editors and writers of technical, science and medical writing
- Engineers, scientists, computer specialists, medical professionals who need to communicate their ideas effectively with a general readership
- Public relations writers
- Freelance writers
- Anyone who wants to explain complex ideas in simple, persuasive language
Ten benefits you'll gain from this one-day seminar!
Through discussion, exercises, and a workbook that will help you to continue learning after the seminar ends, you'll learn how to:
- Use practical information to transform complicated ideas into simple prose, with style and individuality.
- Discover the link between critical thinking, problem solving, and communication. Connect clear, precise thinking with clear, precise writing.
- Apply twenty questions to analyze technical writing for effectiveness.
- Learn how to make your language precise and clear, be forthright, familiar, and flowing.
- Discover how to organize your documents, provide depth, transitions, and emphasis.
- Convey experts' information while keeping the story flowing--and your reader engaged.
- Learn the difference between putting words on paper and communicating information that persuades your reader.
- Banish jargon and buzzwords. Einstein described his Theory of Relativity in simple language. Apply his principles of clear, simple English to your perplexing prose.
- Learn the 12 steps to analyzing your readers' needs/wants and motivations so your message hits the target.
- From planning structure to polishing prose, experience the power of taking ownership of your material. Uncover the core value of facts, wrap that core message in an appealing "what's in it for the reader" form, polish the prose, and prepare for a positive reception to your words.
Instructor:
Donna Elizabeth Boetig is a freelance writer, a former newspaper reporter and a former corporate publication editor whose articles appear frequently in national publications such as Reader's Digest, Family Circle, The Saturday Evening Post and numerous others. Her articles have been translated into hundreds of languages. She has authored and contributed to several books on writing.
Donna was a staff writer for The Baltimore Sun and a feature writer and columnist for The Union Leader in Manchester, NH. In addition to having edited an employee publication for Lockheed Martin, she worked as a contract writer for medical centers and colleges. She is a professor in Johns Hopkins University Masters in Writing Program and is coordinator of the Writing Center at the University of Maryland, graduate and professional programs.
A popular speaker at writers' conferences, Donna has equipped and inspired thousands of writers--both beginners and experienced pros-- to reach new heights of professionalism.
Note: This workshop in only available as customized, onsite training. It can be scheduled as a full-day or half-day program.
Frequently Asked Questions about our Technical Writing Training
Answers provided by our technical writing trainer, Catherine S. Hibbard
Q: What exactly is technical writing?
A: Technical writing is writing that is about a technical subject such as a procedure, a specification, a scientific experiment.
Q: How is technical writing different from regular business writing?
A: The main difference is the technical subject matter and the challenge of reaching multiple types of readers who have differing levels of knowledge about the subject. One document has to “speak to” upper management and subject matter experts.
Q: Why do you customize your technical writing seminars?
A: I have found that different industries write different kinds of documents. What may be a typical document for a pharmaceutical company would not be something that employees who work in a manufacturing plant might write.
Q: Why do you ask potential clients to submit sample documents?
A: Initially, it gives me an idea of the level of writing that is common within the company. Another reason I review documents is to gauge the strengths and weaknesses of writers within the company. Also, if the company uses templates, I can make suggestions as to how the templates may be improved. Most importantly, I use the sample documents to weave pertinent examples throughout the training material. I have found that participants are much more engaged in training that has been specifically tailored to include their types of documents.
Q: Doesn’t it take a lot of time to customize the training materials? Why do you bother?
A: It is time-consuming, but the end result is worth it. The high level of satisfaction of past clients stems partially from the pertinence of the materials and participants’ awareness that their employer has invested a little extra money to ensure that the technical writing class is relevant and meaningful. No one likes training from a traveling road show company that is hit or miss at best. Everyone’s time is valuable, and I guarantee that participants come away with strong new skills that they can put to immediate use.
Q: What else differentiates your technical writing training from that of your competitors?
A: I have a depth of experience that comes from years of specializing in technical writing training and working with a diverse client base. Also, I love training and remain enthusiastic about the subject matter and working with new clients.
To Schedule this Training
For groups of three or more participants
Cypress Media Group presents this seminar as an on-site offering at your work location or at an off-site location of your choice. We can customize this training program to suit your precise training needs.
For economic reasons, this seminar is only offered to groups of roughly three or more people with the same training needs. If you have a group with similar training needs, please call us at 770-640-9918 or e-mail info@cypressmedia.net to discuss your interest.
For fewer than three participants
We do not offer this course as an open enrollment public offering for individuals. If you have fewer than three participants who are interested in this course, the cost will be the same as for a larger group. Please call us at 770-640-9918 or e-mail info@cypressmedia.net to discuss your interest.
Writing Software Available
We recommend that writers use the StyleWriter editing software. StyleWriter will show you how to edit your writing like a pro. You can order a 30-day trial of this remarkable program on the Software for Writers CD. You'll also get four free programs for writers, including a great Dictionary and Thesaurus and six free writing guides on the CD. Click for more information.