Adding help text for a custom field
As our JIRA instance grows, demanding more and more information from the users through the custom fields, it becomes a norm to let the users know what we expect from them. Apart from a bunch of tutorials that we can prepare for them, it makes sense to give them some help right there on the screen, next to the field.
Let us see the various options on how to do it.
Getting ready
Make sure you have the custom field, for which the help needs to be displayed and configured properly.
How to do it...
There are various ways to provide help. Let us see the most widely accepted ways:
Link to a help page.
This is just common sense. Just link to a documentation about the field, hosted somewhere. We can do this easily by adding few hyperlinks in the description of the custom field. We just need to reuse some of the JIRA styles to make sure the help appears consistent across the system.
The hyperlinks again can be added in two ways. They are as follows:
Open the help document...
