PROGRAM DOCUMENTATION STANDARDS

All programs are required to follow the documentation standards.

Comment delimiters are used in a program to identify text documentation comments
from executable commands. TPP uses an exclamation point for comments, !.
TPP:

! THIS IS A COMMENT

The following conventions must be used for documentation in the program.

The program documentation begins with the Program Header, Process Summary, and
Data sections prior to the start of the executable section of the program.
Program Header
A program header contains the programmers name, date, and revision number.
0:!***************************************;
0:!PROGRAM TITLE: THREE PARTS
0:!PROGRAMMER: JOHN SEFCOVIC;
0:!DATE:07-06-06;
0:!REVISION: 1, 07-12-07;
0:!
2, 07-13-07;
0:!***************************************;
Process Summary
A short (abbreviated) summary description of the process.
0:!***************************************;
0:!PROCESS SUMMARY;
0:!***************************************;
0:!THE ROBOT WILL MOVE TO A SAFE POSITION;
0:!WAIT FOR A NEW PART SIGNAL. DETERMINE;
0:!THE PART TYPE FROM THE STATUS OF THE;
0:!INPUT. THE SELECTED PART WILL PICKED-UP;
0:!AND PLACED IN THE FIXTURE;
0:!***************************************;

Data
A complete listing names for positions, I/O, registers, and labels.
For positions, only the key position need to be listed. Key positions are process
important and work points. In the example below [1]-READY is a process
important position. The [3]-AT PART TYPE ONE is the work point at the part,
the position [2] ABOVE PART TYPE ONE is not listed.
0:!***************************************;
0:!POSITIONS;
0:!***************************************;
0:![1]-READY
;
0:![3]-AT PART TYPE ONE ;
0:!***************************************;
See the example on the next page for I/O, registers, and labels.
Section Title
Each major section of the program, i.e. initialization, motion to part 1", or open error
shall be documented with a section title.
0:!***************************************;
0:!************ SECTION TITLE ************;
0:!***************************************;
Documentation in Section
Each major section shall have a short description of sections function in the program.
Additionally, when required for clarification, a section comment may be within the
executable commands.
0:!***************************************;
0:!DOCUMENTATION DESCRIBING A SUB-SECTION;
0:!OF THE PROGRAM. MAY REQUIRE MULTIPLE;
0:!LINES TO COMPLETE;
0:!***************************************;

PROGRAM DOCUMENTATION STANDARDS EXAMPLES

0:!***************************************;
0:!PROGRAM TITLE: THREE PARTS
0:!PROGRAMMER: JOHN SEFCOVIC;
0:!DATE:07-06-06;
0:!REVISION: 1, 7-12-06;
0:!
2, 7-13-06;
0:!***************************************;
0:!PROCESS SUMMARY;
0:!***************************************;
0:!THE ROBOT WILL MOVE TO A SAFE POSITION ;
0:!WAIT FOR A NEW PART SIGNAL. THEN ;
0:!DETERMINE THE PART TYPE FROM THE STATUS ;
0:!OF THE INPUT, ON FOR PART 1 OR OFF FOR ;
0:!PART TWO.;
0:!MOTIONS ABOVE, ALONG THE PART IN LINEAR, ;
0:!AND AWAY WILL BE EXECUTED FOR THE PART;
0:!TYPE.
;
0:!***************************************;
0:!POSITIONS;
0:!***************************************;
0:![1]-READY
;
0:![3]-AT PART TYPE ONE ;
0:!***************************************;
0:!DIGITAL INPUTS;
0:!***************************************;
0:![1] PART_1 ;
0:![2] PART_2 ;
0:![3] PART_3 ;
0:!***************************************;
0:!DIGITAL OUTPUTS;
0:!***************************************;
0:![1] PART_1_ACTV;
0:![2] PART_2_ACTV;
0:![3] PART_3_ACTV;
0:!***************************************;
SAME STRUCTURE FOR ROBOT I/O
0:!***************************************;
0:!REGISTER;
0:!***************************************;
0:![1] PART TYPE NUMBER;
0:!***************************************;
0:!LABELS;
0:!***************************************
0:![1] PART TYPE 1;
0:!***************************************;
0:!
(Use of blank space)
0:!***************************************;
3

0:!***************************************;
0:!**********START OF PROGRAM*************;
0:!***************************************;
0:!**********INITIALIZATION***************;
0:!***************************************;
R[1]=0 or COUNT = 0;
executable command;
executable command;
0:!***************************************;
0:!********MOTION TO SAFE*****************;
0:!***************************************;
0:!ROBOT MOVE TO A SAFE POSITION AND
0:!SIGNALS READY TO BEGIN PRODUCTION
0:!CYCLE
0:!***************************************;
executable command
executable command
executable command
executable command
0:!***************************************;
0:!********PART 1 PROCESS*****************;
0:!***************************************;
0:!ROBOT MOTIONS TO PART 1 AND GRASPS;
0:!THE PART;
0:!***************************************;
executable command
executable command
executable command
executable command
0:!***************************************;
0:!WAIT FOR 5 SEC. FOR GRIPPER TO CLOSE;
0:!OR BRANCH TO ERROR CLOSE SECTION;
0:!***************************************;
executable command
executable command
executable command

PROGRAM DOCUMENTATION STANDARDS.wpd Edited: January 18, 2011