Guidelines for help programs

Two Main Sections: (both Heading 5 on the wiki)

• General Program Information
• Technical Program Outline

Section Information:

General Program Information:

• Final picture of program output with clearly marked origin points and important dimensions
• Specifics Sections (within general section): (Heading 3 on the wiki)
  • Input Definitions - should list any major inputs to the specific program and an explanation of what that input represents, inputs should be listed one after the other, without additional lines between and with a dash ( - ) between the input name and its explanation (inputs that are points should have three bullets beneath the input name, with the x,y,and z explanations at those three bullets) 
    • Inputs Needed to Call Function (Heading 5 on the wiki)
    • Inputs Defined within the Function (Heading 5 on the wiki)
  • Pipe Labeling - Labeling Sections should show images with the specific pieces labeled, as in pictures with many pipes
  • Elbow Labeling
  • etc. (use whichever additional labeling sections that are relevant to the program)

Technical Program Information:

• Should include a step by step explanation of the program with images above the explanation of each step
• Can reference other functions to limit repetitiveness
• Images given should define specific points and dimensions for the program
• When helpful, images should be used to give perspective of the current drawing in relation to its position within the plant
  
  

  Example Help Program Setup

General Program Information

Input Definitions

Inputs Needed to Call Function

width - the width of a specific piece of the program
p2 =

• x : x location of point
• y : y location of point
• z : z location of point

  Inputs Defined within the Function

  Technical Program Information