Professional Documents
Culture Documents
Echnical Riting: Ngineers Uide To
Echnical Riting: Ngineers Uide To
Echnical Riting: Ngineers Uide To
org
Engineers’ Guide to Technical Writing (#06218G)
ENGINEERS’ GUIDE TO
TECHNICAL WRITING
Kenneth G. Budinski
Copyright © 2001
by
ASM International ®
All rights reserved
No part of this book may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means,
electronic, mechanical, photocopying, recording, or otherwise, without the written permission of the copyright
owner.
Great care is taken in the compilation and production of this book, but it should be made clear that NO WAR-
RANTIES, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF MER-
CHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE GIVEN IN CONNECTION WITH
THIS PUBLICATION. Although this information is believed to be accurate by ASM, ASM cannot guarantee that
favorable results will be obtained from the use of this publication alone. This publication is intended for use by per-
sons having technical skill, at their sole discretion and risk. Since the conditions of product or material use are out-
side of ASM’s control, ASM assumes no liability or obligation in connection with any use of this information. No
claim of any kind, whether as to products or information in this publication, and whether or not based on negli-
gence, shall be greater in amount than the purchase price of this product or publication in respect of which dam-
ages are claimed. THE REMEDY HEREBY PROVIDED SHALL BE THE EXCLUSIVE AND SOLE REMEDY
OF BUYER, AND IN NO EVENT SHALL EITHER PARTY BE LIABLE FOR SPECIAL, INDIRECT OR CON-
SEQUENTIAL DAMAGES WHETHER OR NOT CAUSED BY OR RESULTING FROM THE NEGLIGENCE
OF SUCH PARTY. As with any material, evaluation of the material under end-use conditions prior to specifica-
tion is essential. Therefore, specific testing under actual conditions is recommended.
Nothing contained in this book shall be construed as a grant of any right of manufacture, sale, use, or reproduction,
in connection with any method, process, apparatus, product, composition, or system, whether or not covered by
letters patent, copyright, or trademark, and nothing contained in this book shall be construed as a defense against
any alleged infringement of letters patent, copyright, or trademark, or as a defense against liability for such in-
fringement.
Comments, criticisms, and suggestions are invited, and should be forwarded to ASM International.
ASM International staff who worked on this project included Steven Lampman, Acquisitions Editor, Bonnie
Sanders, Manager of Production, Nancy Hrivnak, Copy Editor, Kathy Dragolich, Production Editor, and Scott
Henry, Assistant Director, Reference Publications.
ISBN: 0-87170-693-8
SAN: 204-7586
ASM International®
Materials Park, OH 44073-0002
www.asminternational.org
iii
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
iv
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
v
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Summary of the Elements of Style . . . . . . . . . . . . . . . . . . . . . . . 126
Examples of Writing Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Recommended Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
vi
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
vii
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
viii
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
Preface
THIS BOOK contains material used to train new engineers and techni-
cians in a large manufacturing plant of a Fortune 500 company. It was not
a company-training course. To the contrary, it was one engineer’s attempt
to get coworkers to document their work in a reasonable manner. Cowork-
ers who attended my tutorial sessions went on to become effective techni-
cal writers. In my opinion, our department is the model for the corporation.
Everybody finishes his or her projects with a report. There is a format for
each type of document and a system for archiving these documents. For-
mal reports go to the corporate library, and they are available to all on-line.
It is quite an effective system. The weak link, even today, is that not all
technical people in the company know about the company’s technical doc-
ument protocol, and up to now, there was no text to explain types of tech-
nical documents and how to write them. That is the purpose of this book.
We do not focus on the “laws of the English language.” This book discusses
most types of documents that the average technical person will encounter
in business, government, or industry. The overall objective of the book is
frequent, effective, written documentation and the cost savings produced
by effective communication.
The first iteration of this book was directed toward college students in
the sciences and engineering. The eight or so reviewers, selected by the
publisher, were all English professors, and they thought that the text ma-
terial was somewhat overwhelming for twenty-year-olds who never had
full-time jobs. One reviewer said, “My students do not even know what an
abstract is.” I had to agree with the reviewers; I wrote this book from my
tutorial notes and “my students” were all working technical people. Some
were engineers with twenty years of experience.
I started with a clean sheet of paper and rewrote this book for the prac-
ticing technical person, but in my heart, I feel that this material is not too
ix
© 2001 ASM International. All Rights Reserved. www.asminternational.org
Engineers’ Guide to Technical Writing (#06218G)
much for young minds. Young minds can handle anything. In my opinion,
this book can help students as well as working technical people.
The first four chapters are intended to bring the reader on board—to con-
vince him or her that it is worth the effort to become a reasonably good
technical writer. There is also a chapter on how to conduct technical stud-
ies. I have encountered many experienced technical people who did not
know the basics of conducting a scientific investigation. There is a chap-
ter on how to make effective illustrations and one on how to make oral
presentations. The remaining “teaching” chapters cover specific types of
technical documents: informal reports, formal reports, proposals, corre-
spondence, etc. The book ends with another philosophical chapter. This
one is on how to discipline yourself to get writing tasks done in a timely
manner. Grammar, punctuation, and report mechanics is relegated to the
appendix. Readers who need help can use them. The appendix also con-
tains examples of just about every kind of technical document that one
would encounter including a complete technical paper and a patent.
In summary, this book contains the writing suggestions of a typical en-
gineer with five years experience in the auto industry and thirty-six years
in the chemical process industry. I have written over forty papers for
archival journals, a teaching textbook, and a reference text, and I review
papers for four technical journals. I became heavily involved in writing as
part of a career in research and development. This book reflects what is
needed in industry, and I believe these needs are common in business and
government as well. Effective communications is a prerequisite for a suc-
cessful technical career, and this book presents a system that has proven to
be successful in making effective communicators.
This book is the culmination of five years’ work, including lots of re-
views and rewrites. I thank all reviewers for their honest and helpful sug-
gestions, in particular, Steve Helba and Nancy Kesterson for their work in
getting knowledgeable reviewers and to J.M.J. for ideas. I acknowledge the
talent of Judy Soprano for the chapter and cover art and the hard work of
Angela Leisner at Home-Office Connection in converting my handwritten
text and illustrations into an orderly electronic file. I could not have done
this book without her.
Kenneth G. Budinski
x
ASM International is the society for materials
engineers and scientists, a worldwide network
dedicated to advancing industry, technology, and
applications of metals and materials.
Terms of Use. This publication is being made available in PDF format as a benefit to members and
customers of ASM International. You may download and print a copy of this publication for your
personal use only. Other use and distribution is prohibited without the express written permission of
ASM International.
No warranties, express or implied, including, without limitation, warranties of merchantability or
fitness for a particular purpose, are given in connection with this publication. Although this
information is believed to be accurate by ASM, ASM cannot guarantee that favorable results will be
obtained from the use of this publication alone. This publication is intended for use by persons having
technical skill, at their sole discretion and risk. Since the conditions of product or material use are
outside of ASM's control, ASM assumes no liability or obligation in connection with any use of this
information. As with any material, evaluation of the material under end-use conditions prior to
specification is essential. Therefore, specific testing under actual conditions is recommended.
Nothing contained in this publication shall be construed as a grant of any right of manufacture, sale,
use, or reproduction, in connection with any method, process, apparatus, product, composition, or
system, whether or not covered by letters patent, copyright, or trademark, and nothing contained in this
publication shall be construed as a defense against any alleged infringement of letters patent,
copyright, or trademark, or as a defense against liability for such infringement.