Explain a technical problem with observations and examples

Separate the attempted task, observed result and uncertain cause in a useful support report.

Start with a practical question

A technical support enquiry works better when it separates what happened from what you suspect caused it. Prepare a description that another person can follow without access to your memories or private account. Do not perform risky experiments, change production settings or disclose credentials just to make the report look more complete.

Describe the task you were attempting

Start with the ordinary action: opening a page, submitting an agreed form or retrieving a record. Identify the relevant application or service without including a password, security code or confidential document in the description. If an organisation has a supported reporting form, follow its instructions and include only the information it requests through the verified route.

Mozilla’s bug-writing guidance provides a useful example of distinguishing precise steps, expected results and observed results. Borrow that distinction, not its product-specific troubleshooting procedures. A support process for another organisation may have different permissions, systems and requirements. Your report should make the concern clearer without encouraging unapproved testing.

Record a short reproducible sequence

Write the steps you actually took in their original order. Keep each step concrete enough that a qualified support person can identify the relevant action. “Opened the service page and selected the application-status link” is clearer than “used the website”. Do not claim the issue happens every time if you have observed it only once.

For an illustrative Harare user, a note might say the page displayed an error after an attempted submission, while the expected result was an acknowledgement. That does not establish whether the submission reached the organisation. Include the uncertainty and ask the support team how to check the status safely rather than submitting repeatedly and potentially creating duplicates.

Capture useful evidence carefully

If a screenshot is requested, review what else it shows before sending it. Browser tabs, document names and account information can reveal more than the error itself. Ask the recipient which details are needed and preserve the original privately. Do not publish sensitive material in an attempt to attract a faster response.

Record the visible message accurately, including a reference code if one exists, but avoid turning it into a diagnosis. A message about connectivity does not by itself prove that the service is unavailable to everyone. Note the date and broad circumstances so the team can investigate the relevant event without relying on a confident but unsupported explanation.

Keep the response connected to the report

Save the organisation’s reference and any permitted next step. If you are asked to make a change, confirm that it comes from the verified support route and that you understand its effect. Do not follow instructions from an unsolicited caller to reveal credentials or grant access merely because the caller knows part of your story.

Update the report when new evidence changes the description. Keep earlier observations as part of the sequence, rather than silently rewriting them to match the latest theory. This approach supports an investigation; it does not certify a technical fault, establish responsibility or replace the organisation’s authorised support process.

Sources & further reading

Use these references to check the underlying guidance and any current local requirements. Practical worksheets and illustrative examples in this guide are original educational material.

  1. Mozilla: bug-writing guidelines
  2. Mozilla Support: writing a useful bug report

This guide is general information. Source notes are not a claim of independent professional review.