Intermediate Writing #bug-reports #logs #evidence

Including Logs & Evidence

5 exercises on presenting evidence clearly — error messages, stack traces, screenshots, redacting secrets, and linking logs to the failure.

Key patterns
  • Paste logs as text in a code block — searchable beats a screenshot of text.
  • Redact secrets and PII; mark them <REDACTED>, keep the signal.
  • Screenshots for visual bugs — annotate and caption them.
  • Quote the relevant lines inline; attach the full log for reference.
  • Narrate: tie the log to a timestamp, error, location, and trigger.
0 / 5 completed
1 / 5
You want to include an error in your report. Which is the most useful way to present it?