Skip to main content

How to Submit Effective Troubleshooting Ticket

Submitting a clear and detailed support ticket helps our team investigate and resolve the issue as quickly as possible. The more complete the information, the faster we can pinpoint the root cause and get you back on track.

Updated today

1. Clear Summary

Provide a concise description of the issue in one or two sentences. This helps quickly identify the problem at a glance.

Example:
“Unable to edit past job records—Save button is unresponsive.”

2. Include Key Details

Be specific about where and when the issue is occurring.

  • User(s) affected: (name, role, or user ID if applicable)

  • Client / Unit / Agency:

  • Environment: (Production or Staging)

  • Date and time the issue occurred (approximate):

  • Frequency: (always, intermittent, once)

3. Provide Step-by-Step Reproduction

This is one of the most important sections. Walk us through exactly what the user did leading up to the issue.

Include:

  1. Where the user started (e.g., dashboard, specific module)

  2. Navigation path (click-by-click if possible)

  3. Actions taken (fields entered, buttons clicked)

  4. What happened next

Tip: Assume the reader has never seen the issue before—detail matters.

4. Expected vs. Actual Behavior

Help us understand the gap between what should happen and what is happening.

  • Expected result: What you believe should occur

  • Actual result: What actually occurred instead

5. Attach Supporting Evidence

Visuals and data significantly speed up troubleshooting.

  • Screenshots or screen recordings

  • Error messages (exact text, not paraphrased)

  • File uploads (if applicable)

6. Impact and Urgency

Help us prioritize appropriately by describing the business impact.

  • Is this blocking work?

  • How many users are affected?

  • Is there a workaround available?

8. Contact Information

Include the best way to reach you if we need clarification.

Example of a Strong Ticket

Summary: Unable to edit past job records

Details:

  • User: John Smith (Unit Manager)

  • Environment: Production

  • Occurs every time since April 20, 2026

Steps to Reproduce:

  1. Log in to VMS

  2. Navigate to Jobs > Manage Jobs

  3. Select a previously created job

  4. Click “Edit”

  5. Update a field and click “Save”

Expected Result: Changes are saved successfully
​Actual Result: Save button appears to do nothing; no confirmation or error message

Attachments: Screenshot of job edit page

Impact: Blocking job updates for hiring managers across one agency

Final Tips

  • Be as detailed as possible—this reduces back-and-forth

  • Include exact wording of errors

  • Provide screenshots whenever possible

  • Submit one issue per ticket to keep things focused

By following these guidelines, you’ll help ensure faster resolution times and a smoother support experience.

Did this answer your question?