-
- News
- Books
Featured Books
- design007 Magazine
Latest Issues
Current IssueLevel Up Your Design Skills
This month, our contributors discuss the PCB design classes available at IPC APEX EXPO 2024. As they explain, these courses cover everything from the basics of design through avoiding over-constraining high-speed boards, and so much more!
Opportunities and Challenges
In this issue, our expert contributors discuss the many opportunities and challenges in the PCB design community, and what can be done to grow the numbers of PCB designers—and design instructors.
Embedded Design Techniques
Our expert contributors provide the knowledge this month that designers need to be aware of to make intelligent, educated decisions about embedded design. Many design and manufacturing hurdles can trip up designers who are new to this technology.
- Articles
- Columns
Search Console
- Links
- Events
||| MENU - design007 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
I-Connect007 Editor’s Choice: Five Must-Reads for the Week
04/26/2024 | Andy Shaughnessy, Design007 MagazineIn this week’s roundup, we have a variety of articles covering everything from design through assembly, and even box build. I’ve always wondered whether box build was all it was cracked up to be. Do customers really pick one EMS provider over another because one company offers box build? And if you’ve ever wanted to volunteer, IPC’s Thought Leaders Program is looking for a few good technologists to help them on their mission. Check out Stanton Rak’s article, which was published in the spring issue of IPC Community.
Stan Rak: Elevating the Ideas and Insights of IPC's Thought Leaders Program
04/25/2024 | Stanton Rak, SF Rak CompanyAs a member of the IPC Thought Leaders Program (TLP), I am responsible for identifying knowledge-sharing opportunities that can generate ideas and insights that strengthen the IPC community as well as create a sustainable and lasting future for its members. I am delighted to highlight some of my recent contributions as a member of the TLP.
Alternative Manufacturing Inc. Awarded QML Requalification to IPC J-STD-001 and IPC-A-610
04/24/2024 | IPCIPC's Validation Services Program has awarded an IPC J-STD-001 and IPC-A-610 Qualified Manufacturers Listing (QML) requalification to Alternative Manufacturing Inc (AMI).
IPC Design Competition Champion Crowned at IPC APEX EXPO 2024
04/24/2024 | IPCAt IPC APEX EXPO 2024 in Anaheim, California, five competitors squared off to determine who was the best of the best at PCB design.
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.