Technical Writing


Jason Tesar

I began writing technical documentation in my professional life around the same time as writing fiction became a hobby in my personal life. Over the past 20 years, I’ve worked in a number of roles in engineering-intensive manufacturing and service environments—as an assembly technician, process engineer, quality manager, and quality management system (QMS) consultant. These experiences have shaped my technical writing skills and given me a broad, multi-faceted perspective of documentation system design and the need for instructions to be simple, accurate, and easy to maintain.

Unfortunately for many companies, the personnel who perform the manufacturing work (engineers, technicians, and operators) don’t necessarily posses the organization or written communication skills to properly explain the complexities of what they do. And those tasked with documenting the work (often QA personnel or outsourced writers) may not have sufficient hands-on experience to describe the work itself.

This is the problem I tackle in Writing Manufacturing Procedures. The goal with this book is to pass along my experience to you in order to make the design, creation, and maintenance of your manufacturing documents as easy as possible. Utilizing three basic document types—each with a specific function—I show you how to construct your own manufacturing documentation to be thorough yet efficient, with content that remains relevant as your business grows.

  • If you’d like to read a sample of Writing Manufacturing Procedures or purchase a copy, visit the BOOK PREVIEW section below.
  • If you need a head start in creating your documentation, check out the TEMPLATES section.
  • If you need help designing your document system or writing the content, I offer these services on a contract basis; please contact me for rates and scheduling.

Book Preview



Templates


Equipment Operations Procedure
Equipment Operations Procedure Template — $19.95

The equipment operations procedure provides instructions for operating a piece of manufacturing equipment. It is a distilled version of the owner’s manual for a machine—focused solely on operations—and is used by operators, technicians, engineers, and maintenance personnel. This 13-page template comes pre-formatted with a title page, table of contents, headers and footers, custom styles, writing prompts, and numbered sections for all the topics discussed in Writing Manufacturing Procedures.

To purchase this template, click the Buy Now button below:


Inspection Criteria Specification
Inspection Criteria Specification Template — $14.95

The inspection criteria specification provides requirements for evaluating product. It is a distilled version of an industry standard, focused on a product attribute (or group of attributes) that is not intrinsically linked to a particular process. It is used by operators, technicians, and engineers. This 11-page template comes pre-formatted with a title page, table of contents, headers and footers, custom styles, criteria tables, writing prompts, and numbered sections for all the topics discussed in Writing Manufacturing Procedures.

To purchase this template, click the Buy Now button below:


Process Procedure
Process Procedure Template — $19.95

The process procedure connects the other two document types and explains how and when to use them. It contains all the remaining instructions needed for running a process within a manufacturing environment and is used by operators, technicians, and engineers. This 15-page template comes pre-formatted with a title page, table of contents, headers and footers, custom styles, writing prompts, and numbered sections for all the topics discussed in Writing Manufacturing Procedures.

To purchase this template, click the Buy Now button below:

Share This Page