Accendo Reliability

Your Reliability Engineering Professional Development Site

  • Home
  • About
    • Contributors
  • Reliability.fm
    • Speaking Of Reliability
    • Rooted in Reliability: The Plant Performance Podcast
    • Quality during Design
    • Way of the Quality Warrior
    • Critical Talks
    • Dare to Know
    • Maintenance Disrupted
    • Metal Conversations
    • The Leadership Connection
    • Practical Reliability Podcast
    • Reliability Matters
    • Reliability it Matters
    • Maintenance Mavericks Podcast
    • Women in Maintenance
    • Accendo Reliability Webinar Series
  • Articles
    • CRE Preparation Notes
    • on Leadership & Career
      • Advanced Engineering Culture
      • Engineering Leadership
      • Managing in the 2000s
      • Product Development and Process Improvement
    • on Maintenance Reliability
      • Aasan Asset Management
      • AI & Predictive Maintenance
      • Asset Management in the Mining Industry
      • CMMS and Reliability
      • Conscious Asset
      • EAM & CMMS
      • Everyday RCM
      • History of Maintenance Management
      • Life Cycle Asset Management
      • Maintenance and Reliability
      • Maintenance Management
      • Plant Maintenance
      • Process Plant Reliability Engineering
      • ReliabilityXperience
      • RCM Blitz®
      • Rob’s Reliability Project
      • The Intelligent Transformer Blog
      • The People Side of Maintenance
      • The Reliability Mindset
    • on Product Reliability
      • Accelerated Reliability
      • Achieving the Benefits of Reliability
      • Apex Ridge
      • Metals Engineering and Product Reliability
      • Musings on Reliability and Maintenance Topics
      • Product Validation
      • Reliability Engineering Insights
      • Reliability in Emerging Technology
    • on Risk & Safety
      • CERM® Risk Insights
      • Equipment Risk and Reliability in Downhole Applications
      • Operational Risk Process Safety
    • on Systems Thinking
      • Communicating with FINESSE
      • The RCA
    • on Tools & Techniques
      • Big Data & Analytics
      • Experimental Design for NPD
      • Innovative Thinking in Reliability and Durability
      • Inside and Beyond HALT
      • Inside FMEA
      • Integral Concepts
      • Learning from Failures
      • Progress in Field Reliability?
      • R for Engineering
      • Reliability Engineering Using Python
      • Reliability Reflections
      • Testing 1 2 3
      • The Manufacturing Academy
  • eBooks
  • Resources
    • Accendo Authors
    • FMEA Resources
    • Feed Forward Publications
    • Openings
    • Books
    • Webinars
    • Journals
    • Higher Education
    • Podcasts
  • Courses
    • 14 Ways to Acquire Reliability Engineering Knowledge
    • Reliability Analysis Methods online course
    • Measurement System Assessment
    • SPC-Process Capability Course
    • Design of Experiments
    • Foundations of RCM online course
    • Quality during Design Journey
    • Reliability Engineering Statistics
    • Quality Engineering Statistics
    • An Introduction to Reliability Engineering
    • Reliability Engineering for Heavy Industry
    • An Introduction to Quality Engineering
    • Process Capability Analysis course
    • Root Cause Analysis and the 8D Corrective Action Process course
    • Return on Investment online course
    • CRE Preparation Online Course
    • Quondam Courses
  • Webinars
    • Upcoming Live Events
  • Calendar
    • Call for Papers Listing
    • Upcoming Webinars
    • Webinar Calendar
  • Login
    • Member Home

by Dianna Deeney 1 Comment

QDD 121 Crafting Effective Technical Documents for the Engineering Field

Crafting Effective Technical Documents for the Engineering Field

Ready to hone your technical writing skills as an engineer? This episode of the Quality During Design podcast is a must-listen! We delve into the critical role of technical communication in engineering, and why written communication skills are non-negotiable for engineers. Join me, Dianna Deeney, as we consider different perspectives to make your technical writing the best it can be.

Our chat takes us on a journey through the past, present, and future of technical writing, as we root ourselves in the realities of presenting findings, interpreting data, and making actionable decisions. In the spirit of past, present, and future, we discuss techniques to ensure that your writing is effective and reaches your audience – be it your project team, auditors, or a future engineer referencing your work. Grab your pen and paper or open your word document as we together make strides in improving our technical communication skills.

This Quality during Design Redux episode was originally “The Spirits of Technical Writing Past, Present, and Future”. Visit the podcast blog, here.

 


View the Episode Transcript


Other Quality during Design podcast episodes you might like:

About Using Slide Decks for Technical Design Reviews

QDD Book Cast


Episode Transcript

We all know a part of engineering is actually writing up our results. Some of us like to do it and some of us really just don’t like to do it <laugh>, but it’s a necessary thing because it’s a mode of communication, a mode of communication for a lot of people for different reasons. We may be writing technical reports about the results that we got and coming to a conclusion about our decision about the test results. What are we going to do next? We may be writing protocols for test procedures in order to get those results, and we need to communicate that protocol for other people to independently run the test and do it well, and then there’s things that can happen. The root cause, analyses of failures that happened during tests. All of these kind of writings are things that engineers need to do. It doesn’t always make sense to pass it off to a technical writer. When we’re writing these are, are they getting kicked back to us by the reviewers to add more detail or are we feeling like it’s a little bit fruitless because we don’t feel like the reviewers are actually reading it? They’re not giving us any feedback at all. How do we know when our piece of technical writing is complete? I have a trick for you that I use all the time and it has to do with ghosts. Let’s talk more about it after the brief introduction.

Hello and welcome to Quality During Design, the place to use quality thinking to create products, others love for less. Each week we talk about ways to use quality during design, engineering, and product development. My name is Dianna Deeney. I’m a senior level quality, professional, and engineer with over 20 years of experience in manufacturing and design. Listen in and then join us. Visit quality during design.com.

Do you know what 12 things you should have before a design concept makes it to the engineering drawing board where you’re setting specifications. I’ve got a free checklist for you and you can do some assessments of your own. Where do you stack up with the checklist? You can log into a learning portal to access the checklist and an introduction to more information about how to get those 12 things. To get this free information, just sign up@qualityduringdesign.com. On the homepage, there’s a link in the middle of the page. Just click it and say, I want it.

Technical writing. It is a skill that needs to be learned. I remember early on in my engineering career, I had saved my technical writing textbook from college, and it was really useful. It takes practice, practice, and thankfully engineers get lots of opportunities to practice their technical writing. Our companies probably have templates and forms that we have to fill out and that can be helpful for the company. Everything is in the similar format in the same place. I used to be a little annoyed at that, but as I’ve grown to be a more mature engineer, I understand the purpose of it to make sure that all the information is captured. It’s easier for the reviewers when they’re looking for information in a particular spot. As a quality engineer, I was an independent reviewer on a lot of other people’s technical reports, and there were certain things that I looked for regardless of whether a template was used or not, there’s a practicality to it.

Also, you’re working with somebody else to capture the information that we think we might need. There’s a simple guideline that I use to be able to help me with technical writing and in the technical writing of others that I review, and it really has to do with the audience. Any writing that we do, we want to think of the audience. Well, when we’re writing these technical reports, who is the audience? The people reviewing it. Not necessarily. We have to think a little bit bigger than that. We have to think of the ghosts of technical writing. Past, present, and future. I’m sure you’re at least aware of Charles Dickens’s novel, A Christmas Carol. He wrote it in 1843. It’s the story of Ebenezer’s Scrooge, and he’s an old guy who is miserly. He likes his money. He doesn’t want to share it. And he’s visited by four spirits: his former business partner, but then also the spirits of Christmas past, present, and future (or yet to come).

We can steal from Charles Dickens’s idea to think about the audience that we’re writing for when we’re doing our technical writing pieces. Our audience are the people who are reading it now for approval or are reading it tomorrow after it’s published. It’s also written to the future, and we can think of where we’ve been in the past. Taking these different viewpoints of our audience with our technical writing will make sure that it’s the best it can be, and it’s simple.

Let’s talk about the spirit of writing to the present. We do want to write our technical pieces for who is reading it now, which is probably our project team or our cross-functional team. They are making decisions about what to do with the project based on what they’re reading in the technical report. Also, if we’re in a regulated industry, we may be writing for auditors, third party independent people that are coming in to ensure that we’re doing what we say that we’re doing and that we’re complying with regulations. They look for evidence of that in the reports that we write, and they may come across ours, so I would consider those kinds of reviews also within the realm of writing for the present. In writing for the present, people need to have enough information about what we’ve done, captured in the report so they understand what we’ve done and can decide if they agree with the conclusion, need to see more tests or a different analysis, and then make a decision.

Now, in the spirit of writing to the future, we want to think of another engineer, maybe even 10 years from the time that we’re writing our report. They have the same technical knowledge as we do. We want to write our technical writings so that they can duplicate our results or understand the conclusion that we made and how we got there. This is really clear if we think about a test report and a test protocol, another engineer, 10 years from now, we’ll be able to pick up our report, gather the same equipment, perform the same test, and get the same results, and that’s without us being there because by then maybe we’re working on some other super duper project somewhere else. In this sense, we’re creating technical writings that are independent for themselves. Now, that’s not to say you have to include the whole world in your one document, make references to other documents. As long as that future engineer will be able to pull all the pieces together and recreate what we did, that’s a good check for a technical writing piece.

And the last check for our technical writing to see if it’s complete: we can write to the spirit of our past selves. When we’re in the midst of a project, we’ve got our fingers on the pulse of everything that is going on with the project. We know what the other engineers are doing. We know what manufacturing is developing. We understand how all the puzzle pieces are fitting together. However, in the spirit of writing to the past, our past selves, before we got involved in the project, didn’t know anything about what was going on and what we were trying to accomplish. So when we we’re doing our technical writing, can our past selves from six months ago understand what’s going on and what we’re trying to accomplish?

With any given project there are lots of reports and technical writings, and there’s honestly a lot going on, right? A lot of different people are producing different reports. In the end, we’ll have a dossier in the general meaning, a collection of files about the project that tells the story of how it was developed, what was learned along the product development cycle, the decisions that were made, and ultimately how we got to producing and releasing the product to market.

The term dossier is used at least in medical device manufacturers, but I mean it more in the general sense of a dossier. Even if you’re not working in a regulated industry, having this dossier, this collection of documents will help other new product development teams in the future to kick off their project. We’re not starting from zero anymore. We’ve learned a lot in developing this one product. We can use what we’ve learned to develop other products, and we have a record of what we’ve learned in the dossier and in our technical writings. If we’re having field failures or the performance has changed over time, what has changed about its use environment versus how we tested it? Maybe we didn’t test it to the environment that it’s being used in or having the dossier would be able to tell us that information and help us get to the root cause of the problem.

When we’re working on future projects, even if we didn’t use what we did in the past to start the new one, we’ll have some memory or understanding, “Hey, didn’t our other product do this too? Didn’t we see these kinds of results and what happened there?” We’d be able to look back at the report and find out why these are all ways that we might be able to use our technical writing to help us in the future.

What’s today’s insight to action? Engineers need to write stuff down. It’s part of the job description and part of our responsibilities to do. With any writing, we want to think of the audience, but we can expand that to ensure that our technical writing is the best that it can be. We can write in the spirit of the past, present, and future. We can use these spirits as we’re writing, and we can also run our final drafts through the filters of the spirits, and that will definitely help us communicate our technical expertise to others.

If you like this topic or the content in this episode, there’s much more on our website, including information about how to join our signature coaching program. The quality during design journey. Consistency is important, so subscribe to the weekly newsletter. This has been a production of Deeney Enterprises. Thanks for listening!

Filed Under: Quality during Design

About Dianna Deeney

Dianna is a senior-level Quality Professional and an experienced engineer. She has worked over 20 years in product manufacturing and design and is active in learning about the latest techniques in business.

Dianna promotes strategic use of quality tools and techniques throughout the design process.

Comments

  1. Carl DuPoldt says

    August 13, 2023 at 12:23 PM

    Yes, our documents should tell as story and be useful to others. Great presentation.

    Reply

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

Quality during Design podcast logo

Tips for using quality tools and methods to help you design products others love, for less.


by Dianna Deeney
Quality during Design,
Hosted on Buzzsprout.com
Subscribe and enjoy every episode
Google
Apple
Spotify

Recent Episodes

QDD 128 Leveraging Proven Frameworks or Concept Development

QDD 127 Understanding Cross-Functional Collaboration

QDD 126 Exploring the Problem Space: A Key Principle for Robust Product Design and Project Success

QDD 125 Exploring Product Development and AI Through Literature

QDD 124 Design for User Tasks using an Urgent/Important Matrix

QDD 123 Information Development in Design, with Scott Abel – Part 2 (A Chat with Cross-Functional Experts)

QDD 122 Information Development in Design, with Scott Abel – Part 1 (A Chat with Cross-Functional Experts)

QDD 121 Crafting Effective Technical Documents for the Engineering Field

QDD 120 How to use FMEA for Complaint Investigation

QDD 119 Results-Driven Decisions, Faster: Accelerated Stress Testing as a Reliability Life Test

QDD 118 Journey from Production to Consumption: Enhancing Product Reliability

QDD 117 QDD Redux: Choose Reliability Goals for Modules

QDD 116 Reliability Engineering during Design, with Adam Bahret (A Chat with Cross-Functional Experts)

QDD 115 QDD Redux: 5 Options to Manage Risks during Product Engineering

QDD 114 The Instant Glory of Projects

QDD 113 What to do about Virtual Meetings

QDD 112 QDD Redux: How to self-advocate for more customer face time (and why it’s important)

QDD 111 Engineering with Receptivity, with Sol Rosenbaum (A Chat with Cross-Functional Experts)

QDD 110 Don’t Wish for Cross-Functional Buy-in on Product Designs – Plan to Get It!

QDD 109 Before You Start Engineering Solutions, Do This

QDD 108 QDD Redux Ep. 4: Statistical vs. Practical Significance

QDD 107 QDD Redux Ep. 3: When it’s Not Normal: How to Choose from a Library of Distributions

QDD 106 QDD Redux Ep. 2: How to Handle Competing Failure Modes

QDD 105 QDD Redux Ep. 1: How Many Do We Need to Test?

QDD 104 The Fundamental Thing to Know from Statistics for Design Engineering

QDD 103 What to do for Effective and Efficient Working Meetings

QDD 102 Get Design Inputs with Flowcharts

QDD 101 Quality Tools are Legos of Development (and Their 7 Uses)

QDD 100 Lessons Learned from Coffee Pod Stories

QDD 099 Crucial Conversations in Engineering, with Shere Tuckey (A Chat with Cross-Functional Experts)

QDD 098 Challenges Getting Team Input in Concept Development

QDD 097 Brainstorming within Design Sprints

QDD 096 After the ‘Storm: Compare and Prioritize Ideas

QDD 095 After the ‘Storm: Pareto Voting and Screening Methods

QDD 094 After the ‘Storm: Group and Explore Ideas

QDD 093 Product Design with Brainstorming, with Emily Haidemenos (A Chat with Cross Functional Experts)

QDD 092 Ways to Gather Ideas with a Team

QDD 091 The Spirits of Technical Writing Past, Present, and Future

QDD 090 The Gifts Others Bring

QDD 089 Next Steps after Surprising Test Results

QDD 088 Choose Reliability Goals for Modules

QDD 087 Start a System Architecture Diagram Early

QDD 086 Why Yield Quality in the Front-End of Product Development

QDD 085 Book Cast

QDD 084 Engineering in the Color Economy

QDD 083 Getting to Great Designs

QDD 082 Get Clarity on Goals with a Continuum

QDD 081 Variable Relationships: Correlation and Causation

QDD 080 Use Meetings to Add Productivity

QDD 079 Ways to Partner with Test Engineers

QDD 078 What do We do with FMEA Early in Design Concept?

QDD 077 A Severity Scale based on Quality Dimensions

QDD 076 Use Force Field Analysis to Understand Nuances

QDD 075 Getting Use Information without a Prototype

QDD 074 Finite Element Analysis (FEA) Supplements Test

QDD 073 2 Lessons about Remote Work for Design Engineers

QDD 072 Always Plot the Data

QDD 071 Supplier Control Plans and Design Specs

QDD 070 Use FMEA to Design for In-Process Testing

QDD 069 Use FMEA to Choose Critical Design Features

QDD 068 Get Unstuck: Expand and Contract Our Problem

QDD 067 Get Unstuck: Reframe our Problem

QDD 066 5 Options to Manage Risks during Product Engineering

QDD 065 Prioritizing Technical Requirements with a House of Quality

QDD 064 Gemba for Product Design Engineering

QDD 063 Product Design from a Data Professional Viewpoint, with Gabor Szabo (A Chat with Cross Functional Experts)

QDD 062 How Does Reliability Engineering Affect (Not Just Assess) Design?

QDD 061 How to use FMEA for Complaint Investigation

QDD 060 3 Tips for Planning Design Reviews

QDD 059 Product Design from a Marketing Viewpoint, with Laura Krick (A Chat with Cross Functional Experts)

QDD 058 UFMEA vs. DFMEA

QDD 057 Design Input & Specs vs. Test & Measure Capability

QDD 056 ALT vs. HALT

QDD 055 Quality as a Strategic Asset vs. Quality as a Control

QDD 054 Design Specs vs. Process Control, Capability, and SPC

QDD 053 Internal Customers vs. External Customers

QDD 052 Discrete Data vs. Continuous Data

QDD 051 Prevention Controls vs. Detection Controls

QDD 050 Try this Method to Help with Complex Decisions (DMRCS)

QDD 049 Overlapping Ideas: Quality, Reliability, and Safety

QDD 048 Using SIPOC to Get Started

QDD 047 Risk Barriers as Swiss Cheese?

QDD 046 Environmental Stress Testing for Robust Designs

QDD 045 Choosing a Confidence Level for Test using FMEA

QDD 044 Getting Started with FMEA – It All Begins with a Plan

QDD 043 How can 8D help Solve my Recurring Problem?

QDD 042 Mistake-Proofing – The Poka-Yoke of Usability

QDD 041 Getting Comfortable with using Reliability Results

QDD 040 How to Self-Advocate for More Customer Face Time (and why it’s important)

QDD 039 Choosing Quality Tools (Mind Map vs. Flowchart vs. Spaghetti Diagram)

QDD 038 The DFE Part of DFX (Design For Environment and eXcellence)

QDD 037 Results-Driven Decisions, Faster: Accelerated Stress Testing as a Reliability Life Test

QDD 036 When to use DOE (Design of Experiments)?

QDD 035 Design for User Tasks using an Urgent/Important Matrix

QDD 034 Statistical vs. Practical Significance

QDD 033 How Many Do We Need To Test?

QDD 032 Life Cycle Costing for Product Design Choices

QDD 031 5 Aspects of Good Reliability Goals and Requirements

QDD 030 Using Failure Rate Functions to Drive Early Design Decisions

QDD 029 Types of Design Analyses possible with User Process Flowcharts

QDD 028 Design Tolerances Based on Economics (Using the Taguchi Loss Function)

QDD 027 How Many Controls do we Need to Reduce Risk?

QDD 026 Solving Symptoms Instead of Causes?

QDD 025 Do you have SMART ACORN objectives?

QDD 024 Why Look to Standards

QDD 023 Getting the Voice of the Customer

QDD 022 The Way We Test Matters

QDD 021 Designing Specs for QA

QDD 020 Every Failure is a Gift

QDD 019 Understanding the Purposes behind Kaizen

QDD 018 Fishbone Diagram: A Supertool to Understand Problems, Potential Solutions, and Goals

QDD 017 What is ‘Production Equivalent’ and Why Does it Matter?

QDD 016 About Visual Quality Standards

QDD 015 Using the Pareto Principle and Avoiding Common Pitfalls

QDD 014 The Who’s Who of your Quality Team

QDD 013 When it’s Not Normal: How to Choose from a Library of Distributions

QDD 012 What are TQM, QFD, Six Sigma, and Lean?

QDD 011 The Designer’s Important Influence on Monitoring After Launch

QDD 010 How to Handle Competing Failure Modes

QDD 009 About Using Slide Decks for Technical Design Reviews

QDD 008 Remaking Risk-Based Decisions: Allowing Ourselves to Change our Minds.

QDD 007 Need to innovate? Stop brainstorming and try a systematic approach.

QDD 006 HALT! Watch out for that weakest link

QDD 005 The Designer’s Risk Analysis affects Business, Projects, and Suppliers

QDD 004 A big failure and too many causes? Try this analysis.

QDD 003 Why Your Design Inputs Need to Include Quality & Reliability

QDD 002 My product works. Why don’t they want it?

QDD 001 How to Choose the Right Improvement Model

Join Accendo

Receive information and updates about articles and many other resources offered by Accendo Reliability by becoming a member.

It’s free and only takes a minute.

Join Today

© 2025 FMS Reliability · Privacy Policy · Terms of Service · Cookies Policy