-
- News
- Books
Featured Books
- pcb007 Magazine
Latest Issues
Current IssueDon’t Just Survive, Thrive
If we are to be relevant and prosper during these next critical decades in electronics, we must do more than survive. As an industry, we can and must thrive. In this issue, our contributors explore these concepts meant to help you take your business to the next level.
Material Matters
Materials management is nuanced, multifaceted, and requires a holistic systems approach for business success. When building high mix, low volume, and high technology, managing materials and overall cost containment are even greater challenges.
Additive Manufacturing
In this month’s issue, we explore additive manufacturing technology for the PCB fabricator: where it stands today, the true benefits, and where it seems to be headed.
- Articles
- Columns
Search Console
- Links
- Events
||| MENU - pcb007 Magazine
Happy’s Essential Skills: Technical Writing
May 4, 2016 | Happy HoldenEstimated reading time: 8 minutes
![](https://iconnect007.com/application/files/4417/1686/6064/happy_holden_col_300.jpg)
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
Enhance Your Electronics Expertise Through IPC Courses in August
07/25/2024 | Corey Lynn, IPCAs the global leader in standards, training, and certification for the electronics industry, IPC is pleased to announce an array of upcoming online instructor-led courses this August. These courses are designed to equip professionals with the latest skills and knowledge required to excel in the ever-evolving field of electronics manufacturing and design. Whether you want to deepen your expertise in PCB design and manufacturing, understand the intricacies of intermetallic compounds, or learn about counterfeit part mitigation, IPC has a course tailored for you.
The Knowledge Base: The Value of Industry Certifications
07/24/2024 | Mike Konrad -- Column: The Knowledge BaseIndustry certifications have become increasingly significant in the modern job market, offering a range of benefits to both individuals and employers. These certifications serve as formal recognitions of expertise and proficiency in specific areas, validating a person's skills and knowledge. In the context of the electronics assembly industry, certifications are particularly valuable, given the technical nature of the work and the rapid advancements in technology.
Tom Edman Leads IPC Board of Directors
07/17/2024 | Marcy LaRont, PCB007 MagazineIPC elected several new board members at IPC APEX EXPO in April, including new Board Chair Tom Edman, CEO of TTM, who assumes the role from Bob Neves, CTO and chair of Microtek Laboratories. Tom and TTM have long been active in many facets of IPC. I caught up with Tom and asked him about his new board appointment, IPC, and the industry he serves. He emphasizes IPC’s work in standards and advocacy as especially important for our industry.
Getting Clear About Certification With Charlie Capers
07/17/2024 | I-Connect007 Editorial TeamWalk through the entrance at Zentech Dallas and you’ll see a wall of certification plaques prominently displayed. Beyond being impressive and a point of pride, these certifications tell a story to potential customers: This company is ready to do business. Charlie Capers, former vice president and general manager, shares his insights on quantifying the ROI of certifications. You may not see it on paper, but it’s definitely there. He also talks about his expectations for new hires and shares a case study about the importance of collaborating with your PCB designers.
Winners of 2024 IPC Masters Competition China Announced
07/17/2024 | IPCFrom July 8-10, the 2024 IPC Masters Competition China was successfully held in Pudong, Shanghai. This year’s competition, was the largest in the history of the Greater China region, bringing nearly 400 electronics industry elites from 18 provinces and municipalities.