Magic Title Rule Creation Guide
đ Purpose of Title Rules
The purpose of title rules is to generate clear, consistent, and actionable ticket titles using simple prompt-based instructions. These rules tell Magic Title what to include, exclude, or emphasize when summarizing a request.
You can also use runtime variables to dynamically insert context into the title, ensuring every ticket is easy to scan, sort, and understand.
đŻ Objectives of Title Rules
- Ensure concise and clear ticket titles.
- Avoid unnecessary or redundant information (e.g., greetings, filler words).
- Maintain consistency across all categories of requests.
- Align titles with predefined categories or formats when applicable.
đ Guidelines for Writing Title Rules
- Keep titles concise (3-4 words maximum).
- Avoid greetings, pleasantries, or generic terms (e.g., "Hi," "Help").
- Focus on the specific issue or action required.
- Use clear, descriptive language to ensure quick understanding.
Example Templates for Rules
Use these templates as a foundation for crafting effective prompts:
- Default Prompt Example
"Provide a short and concise title for the ticket, including the initial problem. Ignore words like greetings or help."
- Format-Specific Prompt
"Write a concise, three-word title summarizing the issue. Use action-oriented language and avoid filler words."
- Keyword Extraction Prompt
"Analyze the request details and extract the most relevant keywords to form a clear and concise title."
- Role-Based Prompt
"Imagine youâre a technician receiving this request. Summarize the issue in a title that is actionable and clear, using 3-4 words."
- Prefix-Based Prompt
âGenerate a title with the correct prefix based on the request type: ACC: Access requests (e.g., âACC - Permissions Neededâ); SFWI: Software issues (e.g., âSFWI - Installation Errorâ); HWI: Hardware problems (e.g., âHWI - Printer Offlineâ); PSWR: Password resets (e.g., âPSWR - Reset Passwordâ); ACCI: Account issues (e.g., âACCI - Locked Accountâ); CONN: Connectivity issues (e.g., âCONN - VPN Failureâ). Use the prefix and summarize the issue in 3-4 words. Example: âSFWI - App Crash.ââ
đ ď¸ Categories of Titles
When applicable, categorize titles into predefined groups for clarity and standardization. Example categories include:
- Access Requests: e.g., "Access Permissions Needed"
- Software Issues: e.g., "Software Installation Error"
- Hardware Issues: e.g., "Printer Connection Failed"
đĄ Best Practices
- Be Consistent: Use the same structure and tone across all prompts.
- Iterate Based on Feedback: Regularly refine prompts based on user input.
- Test for Clarity: Ensure prompts are easy to understand and follow.
- Consider Automation: Align prompts with AI systems to automate title generation effectively.