Engineers: Improve your writing

Think Again: 7 quick tips can help engineers improve writing and editing. Use this advice on your next piece.

02/21/2011


Mark T. Hoske, Control Engineering, CFE MediaPoor project documentation is the downfall of many projects, and writing skills are the downfall of many engineers, suggests Dennis Brandl in this month’s “Engineering and IT Insight” titled, “Bad project documentation: Break the habit,” on page 16.

Brandl, who also writes and rewrites a lot as a consultant and standards editor, observes that manufacturing IT, automation, and control projects improve with complete, correct, and well-written documentation. Why do some engineers have trouble writing?

“There may be something in the engineer’s brain that is at odds with clear and effective writing skills, or it may be that engineers have not learned critical writing skills. Poor documentation habits are often accompanied by poor review habits. Many engineers don’t even know how badly they write because their documents are reviewed for technical correctness but not for completeness, clarity, and readability,” Brandl said.

Perhaps engineers are so excited about engineering, they want to get on with that. Unfortunately, poor writing can reflect badly on good engineering. Seven tips follow on how engineers can improve writing and editing.

1. Know the purpose and goals of the document.

2. Write an outline. Like a sketch for a design, an outline helps keep the piece on track.

3. The introduction or lead should summarize and present the most important aspects of what’s to follow. Each section of a longer piece should do the same.

4. Review and mark up the piece, once for completeness and again for clarity. Even the simplest engineering project gets revised and improved before it’s done. Writing is similar. If there’s time, let it sit a day or two, and review it again. Let a coworker, especially one not involved in project details, review and mark up the document or at least discuss weaknesses.

5. Revise, observing notes and edits. Get to the point. Eliminate excess words.

6. Look again at the conclusion. Often by the ending, there’s a clearer understanding of the subject. Just when you thought you were done may be the best time to revise the beginning.

7. Finished? Think again. Read it out loud. You’ll find at least three more things to fix.

-

Write for Control Engineering. See details at www.controleng.com/contribute.



No comments
The Top Plant program honors outstanding manufacturing facilities in North America. View the 2015 Top Plant.
The Product of the Year program recognizes products newly released in the manufacturing industries.
The Engineering Leaders Under 40 program identifies and gives recognition to young engineers who...
Hannover Messe 2016: Taking hold of the future - Partner Country status spotlights U.S. manufacturing; Honoring manufacturing excellence: The 2015 Product of the Year Winners
Inside IIoT: How technology, strategy can improve your operation; Dry media or web scrubber?; Six steps to design a PM program
World-class manufacturing: A recipe for success: Finding the right mix for a salad dressing line; 2015 Salary Survey: Manufacturing slump dims enthusiasm
Getting to the bottom of subsea repairs: Older pipelines need more attention, and operators need a repair strategy; OTC preview; Offshore production difficult - and crucial
Digital oilfields: Integrated HMI/SCADA systems enable smarter data acquisition; Real-world impact of simulation; Electric actuator technology prospers in production fields
Special report: U.S. natural gas; LNG transport technologies evolve to meet market demand; Understanding new methane regulations; Predictive maintenance for gas pipeline compressors
Warehouse winter comfort: The HTHV solution; Cooling with natural gas; Plastics industry booming
Managing automation upgrades, retrofits; Making technical, business sense; Ensuring network cyber security
Designing generator systems; Using online commissioning tools; Selective coordination best practices

Annual Salary Survey

Before the calendar turned, 2016 already had the makings of a pivotal year for manufacturing, and for the world.

There were the big events for the year, including the United States as Partner Country at Hannover Messe in April and the 2016 International Manufacturing Technology Show in Chicago in September. There's also the matter of the U.S. presidential elections in November, which promise to shape policy in manufacturing for years to come.

But the year started with global economic turmoil, as a slowdown in Chinese manufacturing triggered a worldwide stock hiccup that sent values plummeting. The continued plunge in world oil prices has resulted in a slowdown in exploration and, by extension, the manufacture of exploration equipment.

Read more: 2015 Salary Survey

Maintenance and reliability tips and best practices from the maintenance and reliability coaches at Allied Reliability Group.
The One Voice for Manufacturing blog reports on federal public policy issues impacting the manufacturing sector. One Voice is a joint effort by the National Tooling and Machining...
The Society for Maintenance and Reliability Professionals an organization devoted...
Join this ongoing discussion of machine guarding topics, including solutions assessments, regulatory compliance, gap analysis...
IMS Research, recently acquired by IHS Inc., is a leading independent supplier of market research and consultancy to the global electronics industry.
Maintenance is not optional in manufacturing. It’s a profit center, driving productivity and uptime while reducing overall repair costs.
The Lachance on CMMS blog is about current maintenance topics. Blogger Paul Lachance is president and chief technology officer for Smartware Group.
This article collection contains several articles on the vital role that compressed air plays in manufacturing plants.
This article collection contains several articles on the Industrial Internet of Things (IIoT) and how it is transforming manufacturing.
click me