SUPPORT / TROUBLESHOOTING
Document a technical support issue.
A useful issue report makes the failure distinguishable from normal behavior. Start with observable facts, preserve the context and avoid tests that could alter records or create duplicate actions.
1. State the expected and observed result
Name the task you were performing. Describe what should have happened and what happened instead, including exact error text when available. Write “the status remained pending” rather than “the database is broken” unless the cause has been established.
2. Record when and where it happened
Include the date, time and time zone, affected page or workflow, and whether the environment is a test or live system. Note the browser or application version if known. Remove secret tokens and private record details from URLs or screenshots before sharing them.
3. Establish the known scope
State whether you observed the issue for one record, one user or several users. Distinguish confirmed observations from reports you have not checked. Note the last known successful attempt and any relevant change, without assuming that timing proves causation.
4. Reproduce only when the action is safe
List the steps that led to the result. If an action can charge money, send a message, create a record or change permissions, do not repeat it merely to test whether it worked. Verify the existing result through an authorized view or ask the responsible operator before retrying. Do not delete data or change configuration to test an unconfirmed explanation.
5. Explain impact and preserve evidence
State the blocked task, affected people and available workaround. Record any troubleshooting already performed and its result. Use redacted screenshots or synthetic examples where practical. Share logs only through an agreed route after checking them for credentials and sensitive information.
Stop when further testing creates risk
If investigation could expose data, disrupt operations or change important records, stop and use the appropriate support or incident process. Send the evidence collected so far and identify what remains unknown; a safe, incomplete report is better than an avoidable production change.
Technology Solutions & Business Services