Creating instruction help, Write clear descriptions – Rockwell Automation Logix5000 Controllers Add-on Instructions Programming Manual User Manual
Page 63
Defining Add-On Instructions
Chapter 2
Tip:
When an instruction is sealed, the instruction signature is displayed on the faceplate of the instruction in
the Ladder Diagram Editor and the Function Block Diagram Editor.
You can turn off the display of the instruction signature in the Workstation Options dialog box of Logix Designer application.
You can also view the instruction signature and the safety instruction signature on
the Quick View pane of the Controller Organizer and on the Signature tab of
the Instruction Definition Editor.
The Add-On Instruction name, revision, instruction signature, safety instruction
signature, and timestamp are printed on the Add-On Instruction Signature
Listing report. You can also include the instruction signature, safety instruction
signature, and signature history on the Add-On Instruction report by clicking
Print Options on the Generate Report dialog box.
Custom instruction help is generated automatically as you are creating your
Add-On Instructions. Logix Designer application automatically builds help for
your Add-On Instructions by using the instruction’s description, revision note,
and parameter descriptions. By creating meaningful descriptions, you can help the
users of your instruction.
In addition, you can add your own custom text to the help by using the Extended
Description field. You can provide additional help documentation by entering it
on the Help tab on the Add-On Instruction Definition Editor. The instruction
help is available in the instruction browser and from any call to the instruction in a
language editor by pressing F1.
Write clear descriptions
When writing your descriptions keep the following in mind:
• Use short sentences and simple language.
• Be brief and direct when you write.
• Include simple examples.
• Proofread your entries.
Creating instruction help
Rock well Automati on Publication 1756- PM010F-EN-P - Oct ober 2014
63