Program Help Page Guidelines

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 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 then explanation 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