Alert   Product Alerts
Keep current on the latest products, new suppliers, and technical articles of interest to you. (See Topics)

Chapter 49: Program Documents

By Peter Smid
From CNC Programming Handbook: A Comprehensive Guide to Practical CNC Programming, Third Edition

OVERVIEW

During program preparation, quite a number of individual pieces of documentation will accumulate. All sketches, calculations, setup sheets, tooling sheets, job descriptions, instructions to the operator and related notes contain valuable information. This information should be stored as part of the program documentation folder. Any changes to the finished program at a later date, for whatever reason, can be done much easier if the documentation is complete, well organized and stored in one place. A good documentation makes a review of the program at a later date much easier. If some-body else has to review a program, the documentation will save much of the valuable time. The way programmers document programs reflects not only their personal programming style, it also becomes a reliable indication of their sense of discipline and organizational capabilities.

A simple definition relating to program documentation can be presented:

Program documentation is a set of all records necessary to retrace the program development

Many CNC programmers, even machine shop supervisors, underestimate the importance of good program documentation. Their main arguments are that any paperwork is not worth the time, that it takes too long to collect all documents and prepare the documentation, that it is essentially a nonproductive effort, etc. These arguments are true, up to a point - in order to make a good documentation, yes, some time will be required. Not an excessive amount of time, but enough time to do a good job. If there are prepared blank forms available, they just need...

Copyright Peter Smid 2007 under license agreement with Books24x7

Products & Services
Bug tracking software enables developers to use breakpoint and stepping methods to troubleshoot source code written for computers and embedded systems. These stand-alone computer applications are not part of an integrated development environment (IDE). Learn more about Bug Tracking Software
Technical communications services design, write, re-write, and edit product datasheets, MSDS sheets, GMP or GLP documents, service manuals, training documents, illustrations, and other technical information. Learn more about Technical Communications Services
Calibration software is used to generate documentation of calibration results, calibration certificates and reports. It also provides lookups of calibration procedures and database functions. Learn more about Calibration Software
Safety and health services perform testing, consulting and analytical activities related to worker protection, industrial hygiene, process accidents, facility dangers, occupational hazards, and consumer product safety. Learn more about Safety and Health Services
Instrument calibration services test equipment and calibrate them to various standards.   Search by Specification | Learn more about Instrument Calibration Services

Product Announcements
Ellsworth Adhesives - Label And Documentation Experts
Ellsworth Adhesives' ability as label and documentation control experts allows us to work with our customer to improve their quality control and ultimately save the end-user both valuable time and... (read more)
Therma-Tron-X, Inc. - Information Management for Finishing Operation
A Therma-Tron-X System Documentation Package can save your business money and assist in ISO 9000 compliance by monitoring resource usage 24 hours a day, seven days a week. Crucial operating parameters... (read more)
Bowen & Groves Inc. - M1 Job Management Module
M1 Job Management allows you to better manage your production jobs. Raw material demands are automatically updated with the job. Job costs are automatically updated with every job transaction. (read more)
Emerson Network Power / Liebert Power & Cooling - Assessment Improves Availability & Efficiency
Data centers are dynamic. Changes may have increased your vulnerability for unplanned downtime, created numerous inefficient operations or both. Find out how to identify and resolve. (read more)
Allen-Bradley / Rockwell Automation - Best Practice Tools for PLC & HMI systems
Connected Components Building Blocks (CCBB) from Rockwell Automation provides you with information you need to quickly & easily implement common control tasks in your machine design. CCBB include... (read more)
PTC - Arbortext IsoDraw - Produce Documentation as Advanced as Your Products
Windchill®-Arbortext® integration enables you to manage all product information, including product designs, manufacturing instructions, support information, and technical documentation, with a single... (read more)
Iseli Co. - AEROSPACE COMPONENTS– SWISS MANUFACTURING
. Our quality systems are in accordance with MIL-I-45208. Iseli has been a leading provider for many decades of components to major companies in the defense and aerospace industries. As one of the... (read more)
Iseli Co. - PRECISION AUTOMOTIVE COMPONENTS – SWISS
As a ISO 9001:2000 Certified Company, our internal systems are designed to support your requirements. Tyco, Parker Hannifin and Champion Automotive Parts are just a few of the leading companies that... (read more)

Topics of Interest
OVERVIEW When a CNC program is completed, there will be a written copy or a file copy stored somewhere on a computer. At this point, the program development is fully completed. It may be a perfect... (Read More)
OVERVIEW During the program preparation, quite a number of various pieces of documentation will accumulate. All sketches, calculations, setup sheets, tooling sheets, job descriptions, instructions... (Read More)
Overview Most programmers hold documentation in the same regard as root canal surgery. Meanwhile, users hold documentation dear to their hearts. The only resolution is for you, the LabVIEW... (Read More)
Why Do I Need A Design? The importance of a good structure cannot be overstated. It is essential so that different programmers can understand how their product fits into the whole, and other teams... (Read More)
Gen. Richard Cody, Army vice chief of staff, says turning the Joint Cargo Aircraft (JCA) program into a single acquisition and operation platform under the Air Force would mean significant cost... (Read More)