-
- News
- Books
Featured Books
- pcb007 Magazine
Latest Issues
Current IssueAlternate Metallization Processes
Traditional electroless copper and electroless copper immersion gold have been primary PCB plating methods for decades. But alternative plating metals and processes have been introduced over the past few years as miniaturization and advanced packaging continue to develop.
Technology Roadmaps
In this issue of PCB007 Magazine, we discuss technology roadmaps and what they mean for our businesses, providing context to the all-important question: What is my company’s technology roadmap?
Wet Process Control
In this issue, we examine wet processes and how to obtain a better degree of control that allows usable data to guide our decisions and produce consistently higher-quality products.
- Articles
- Columns
Search Console
- Links
- Media kit
||| 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
The Government Circuit: Support for Defense Spending Takes Top Priority
10/15/2024 | Chris Mitchell -- Column: The Government CircuitFor those of us living in the world of politics and policy, the final few weeks before a major election are a little nerve-wracking. Who is going to win? How might the candidates’ campaign promises affect our industry and our strategies over the next few years? One thing I do know: No matter who wins the White House and control of Congress on Nov. 5, IPC will continue working with members of both major parties to advance policies that boost innovation, investment, and growth and ensure the electronics manufacturing industry’s long-term success. We must.
Thinking Out of the Box: Pacific Northwest EMS Manufacturer Employs Successful Strategies With IPC
10/15/2024 | Michelle Te, IPC CommunityAllison and Chad Budvarson started Out of the Box Manufacturing, an EMS company in Renton, Washington, just one month after they were married in 2008. To stay competitive, they’ve utilized IPC’s workforce subscription and apprenticeship programs to train and maintain their staff. "Our relationship with IPC has evolved over the past several years," Allison says. "Initially, we saw IPC for its standards. But when I started attending the EMS Leadership Summit at APEX EXPO, I realized there was so much more to IPC, which opened more doors for us, creating growth and partnership opportunities I didn't realize were possible. For one, I like having frank conversations with EMS owners from other areas of the country, and I’m not worried they will steal my 'secret sauce.'"
Fall 2024 Issue of IPC Community Now Available
10/14/2024 | IPC Community Editorial TeamThere’s so much happening at IPC, so be sure to open the latest issue of IPC Community, brimming with must-read features on members of the electronics industry who are making a difference in their own unique way. Just for starters, our member profiles feature Virginia-based Weidmuller, a heart-warming story from E-Tron, and you’ll discover how the owners of Out of the Box Manufacturing are successfully tackling workforce talent challenges.
Discover TRI's Solutions at Manufacturing Indonesia 2024
10/14/2024 | TRIPT Hibex Indonesia, the distributor of Test Research, Inc. (TRI), will take part in Indonesia's Leading Manufacturing, Machinery, Equipment, Materials, and Services Event, Manufacturing Indonesia 2024.
Nortech Systems Announces Expansion of PCBA Capabilities with IPC-J-STD-001 Space Addendum
10/08/2024 | BUSINESS WIRENortech Systems Incorporated (“Nortech Systems”, or the “Company), a leading provider of engineering and manufacturing solutions for the aerospace and defense industry, has announced the Company has certified trainers and operators to build printed circuit board assemblies (PCBAs) to the IPC-J-STD-001 Space Addendum standard.