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 2013 Top Plant.
The Product of the Year program recognizes products newly released in the manufacturing industries.
The Leaders Under 40 program features outstanding young people who are making a difference in manufacturing. View the 2013 Leaders here.
The new control room: It's got all the bells and whistles - and alarms, too; Remote maintenance; Specifying VFDs
2014 forecast issue: To serve and to manufacture - Veterans will bring skill and discipline to the plant floor if we can find a way to get them there.
2013 Top Plant: Lincoln Electric Company, Cleveland, Ohio
Case Study Database

Case Study Database

Get more exposure for your case study by uploading it to the Plant Engineering case study database, where end-users can identify relevant solutions and explore what the experts are doing to effectively implement a variety of technology and productivity related projects.

These case studies provide examples of how knowledgeable solution providers have used technology, processes and people to create effective and successful implementations in real-world situations. Case studies can be completed by filling out a simple online form where you can outline the project title, abstract, and full story in 1500 words or less; upload photos, videos and a logo.

Click here to visit the Case Study Database and upload your case study.

Bring focus to PLC programming: 5 things to avoid in putting your system together; Managing the DCS upgrade; PLM upgrade: a step-by-step approach
Balancing the bagging triangle; PID tuning improves process efficiency; Standardizing control room HMIs
Commissioning electrical systems in mission critical facilities; Anticipating the Smart Grid; Mitigating arc flash hazards in medium-voltage switchgear; Comparing generator sizing software

Annual Salary Survey

Participate in the 2013 Salary Survey

In a year when manufacturing continued to lead the economic rebound, it makes sense that plant manager bonuses rebounded. Plant Engineering’s annual Salary Survey shows both wages and bonuses rose in 2012 after a retreat the year before.

Average salary across all job titles for plant floor management rose 3.5% to $95,446, and bonus compensation jumped to $15,162, a 4.2% increase from the 2010 level and double the 2011 total, which showed a sharp drop in bonus.

2012 Salary Survey Analysis

2012 Salary Survey Results

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.