Prompt descriptions serve as built-in instructions that help your colleagues understand how to use your prompts effectively. By adding clear descriptions, you can provide context, purpose, and usage guidelines without cluttering the prompt itself.
π Why Use Prompt Descriptions?
Descriptions make your prompts more user-friendly by:
Reducing confusion about how the prompt should be used
Providing context that helps users understand the prompt's purpose
Offering guidance on expected inputs and outputs
Saving time by answering common questions upfront
βοΈ How Descriptions Appear to Users
When you add descriptions to your prompts, they appear in different ways:
Short descriptions show up as an introduction to your prompt form
Users can click the "Read more" button to expand and see the full long description
The long description appears on the side of the screen, providing detailed information
Your prompt descriptions will be visible:
In the Use tab of your prompt's playground
When sharing prompts on public pages
When publishing prompts in the community
β Adding Effective Descriptions
Keep short descriptions concise - aim for a quick overview
Use long descriptions for details - include examples, use cases, and specific instructions (use markdown to format text, expand context, and highlight relevance)
Be clear about inputs - explain what information users need to provide
Outline expected outcomes - help users understand what results to expect
By taking a few moments to write thoughtful descriptions, you can significantly improve how effectively your team uses your prompts and reduce the need for additional explanation.