A PRACTICAL NOTE · Formatting

How to apply this guide

Keep what you saw separate from the suspected cause when preparing a reproducible issue.

Start with

Name the version, starting screen and first action. Speak an expected result and an actual result separately. For an audio issue, include whether the mic meter and transcript changed.

Check before you finish

Place the reviewed text into the tracker’s fields. Use a harmless example instead of private customer data. Include whether a second attempt behaved the same way.

Evidence to keep: Compare the source words with the formatted draft and make sure meaning, names, dates and commitments remain intact. This page’s key limit is: Keep what you saw separate from the suspected cause when preparing a reproducible issue.

Start here

A good bug report tells another person how to see the same result. Your first spoken version can be conversational. The reviewed version should preserve the steps and label any guess about cause.

Dictate a minimal sequence

Name the version, starting screen and first action. Speak an expected result and an actual result separately. For an audio issue, include whether the mic meter and transcript changed.

Preserve the evidence

Read the original next to the draft. Check versions and quoted error labels on screen. Keep untested theories outside the reproduction steps, especially if a rewrite made them sound confirmed.

Paste one clean report

Place the reviewed text into the tracker’s fields. Use a harmless example instead of private customer data. Include whether a second attempt behaved the same way.

Keep exploring