-
- News
- Books
Featured Books
- pcb007 Magazine
Latest Issues
Current IssueThe Growing Industry
In this issue of PCB007 Magazine, we talk with leading economic experts, advocacy specialists in Washington, D.C., and PCB company leadership to get a well-rounded picture of what’s happening in the industry today. Don’t miss it.
The Sustainability Issue
Sustainability is one of the most widely used terms in business today, especially for electronics and manufacturing but what does it mean to you? We explore the environmental, business, and economic impacts.
The Fabricator’s Guide to IPC APEX EXPO
This issue previews many of the important events taking place at this year's show and highlights some changes and opportunities. So, buckle up. We are counting down to IPC APEX EXPO 2024.
- Articles
Article Highlights
- Columns
Search Console
- Links
- Events
||| MENU - pcb007 Magazine
Happy’s Essential Skills: Technical Writing
May 4, 2016 | Happy HoldenEstimated reading time: 8 minutes
Technical writing is one of those topics that they don’t really talk about in college—at least not where I went. Writing and English has never been a strong like of mine compared to science and math. So I did my required time in English and wrote my lab reports the best I knew how. Even my senior projects and graduate reports were mostly graphs, tables, figures and drawings and the necessary information to explain what they were.
After taking my first job with Hewlett-Packard, it took me only a year to realize one startling fact: Only the bosses get to go to conferences! Junior engineers don’t get to go to conferences. But I wanted to learn more, meet other engineers in printed circuit manufacturing, see the latest equipment and listen to technical papers about my new field. Then I discovered the secret solution: If I presented a technical paper, the company was happy to send me to the conference.
I set out to write my first technical paper and discovered the process of technical writing and company legal reviews. I presented my first paper on our automated plating project at NEPCON in Anaheim in 1971. All went very well—and I decided that I would write a technical paper every other year. That went well for a while, but then I was writing a technical paper every year, then two or three a year for magazines, and soon marketing was asking me to write five or six each year, since I was writing a lot about HP hardware and software. This progressed over the next 40 years to columns, blogs, book chapters and eventually, an entire book.
Figure 1: General overview of technical writing applications.
Why is Technical Writing Important?
Technical writing consists of straightforward, easy to understand explanations and/or instructions dealing with a particular subject. It is an efficient and clear way of explaining something and how it works. An author writes about a particular subject that requires directions, instructions, or explanations. Technical writing has a very different purpose and is comprised of different characteristics than other types of writing, such as creative, academic or business.
The subject of technical writing can be one of two things:
- Tangible: Something that can be seen or touched (e.g., a computer or software program, or how to assemble a piece of furniture).
- Abstract: Something that involves a series of steps unrelated to a tangible object (e.g., steps required to complete a laboratory process).
Some examples of technical writing include:
- Technical papers
- Instruction manuals
- Policy manuals
- Memos
- Grants
- White papers
- Process manuals
- User manuals
- Reports of analysis
- Instructions for assembling a product
Writing Processes
I believe that it is always good to have a process, and technical writing is a perfect fit for that. Some of the problem solving processes discussed in previous installments of this series are useful, like the scientific method. But all processes start with an idea or even just a thought like, “What are you going to write about?”
Figure 2: General technical writing process.
Mind-Mapping
A mind map is defined by Wikipedia as “a diagram used to visually organize information. A mind map is often created around a single concept, drawn as an image in the center of a blank landscape page, to which associated representations of ideas such as images, words and parts of words are added. Major ideas are connected directly to the central concept, and other ideas branch out from those.” Figure 3 shows a typical Wikipedia mind map.
For any form of topic organization, I find that being able to see it arranged graphically is very helpful, and would strongly recommend the mind-mapping approach. It's also brilliant for taking notes at meetings—I've even projected notes while the meeting was taking place, so that everyone could see what they had said and its context!
This method is illustrated in Figures 4 and 5, in which a simple mind map is built on the topic of stencil printing variables. In the most complete version, some of the groupings and causal linkages have been drawn and appropriate notes have been added.
Figure 3: Wikipedia mind map of typical guidelines.
Figure 4: Stages in the evolution of mind-map notes.
Mind maps are considered to be a type of spider diagram. A similar concept is brainstorming. Brainstorming will be covered in an upcoming column.
Page 1 of 2
Suggested Items
Big Win for Defense Production Act Budget Allocation in FY24 Budget
04/23/2024 | I-Connect007 Editorial TeamOne year ago, President Biden issued a determination that chips and packaging are critical for national security. Since that time, much work has been done to continue the conversation in Washington, elevating the importance of the entire chips value chain, and including printed circuit boards and substrates, without which chips cannot operate.
Real Time with... IPC APEX EXPO 2024: A Conversation with IPC's CEO: New Venue, Sustainability, and More
04/23/2024 | Real Time with...IPC APEX EXPOBarry Matties hosts Dr. John W. Mitchell, CEO of IPC, on the final day of IPC APEX EXPO 2024. They discuss the new venue in Anaheim and broach a range of topics, from traffic and booth experiences to workforce development, sustainability, and the CHIPS Act. And they offer advice for newcomers as IPC looks forward to an even better show experience next year.
Boeing's Janene Stinson Earns IPC Excellence in Education Award at IPC APEX EXPO 2024
04/22/2024 | IPCThe IPC Excellence in Education award was presented to Janene Stinson, Boeing, at IPC APEX EXPO 2024 in Anaheim, California, in recognition of her significant contributions to workforce development and leadership.
What’s Next Becomes Now at IPC APEX EXPO 2024
04/22/2024 | IPCFrom revolutionary advancements in artificial intelligence, augmented reality and the latest innovations in capital equipment on the show floor to a heightened learner experience through the 16th Electronic Circuits World Convention (ECWC16) technical conference, IPC APEX EXPO 2024 provided education, professional development and numerous networking opportunities, for 3,723 attendees from 57 countries.
Real Time with... IPC APEX EXPO 2024: Looking Back, Looking Forward With IEC
04/19/2024 | Real Time with...IPC APEX EXPOIEC came to the RTW booth and discussed both the legacy of IEC's past and the vision for its future. Industry veteran Bruno Ferri highlighted his quarter-century tenure in the industry and with IEC since its founding. He still exhibits boundless enthusiasm for the industry. Brando Stone, a young professional and a future face of IEC, talked about IEC's plans going forward and his experience at this year's IPC APEX EXPO.