Skip to content

Instantly share code, notes, and snippets.

@joymon

joymon/scientific_debugging_template.md

Last active May 21, 2024 19:17
Show Gist options
  • Save joymon/00661bd1c46a99ed2baea9dbe9a81f92 to your computer and use it in GitHub Desktop.
Save joymon/00661bd1c46a99ed2baea9dbe9a81f92 to your computer and use it in GitHub Desktop.
Download ZIP
Scientific debugging template to track progress
Raw
scientific_debugging_template.md

Status - [Open/Closed]

Overview

  • Reported on - [Date]
  • Last updated on - [Date]
  • Environment - [All/Staging/Prod/QA/Dev]
  • Investigators
    • Person 1
    • Person 2

Description

[Short description about issue]

Reproduction steps

[Steps if available]

  1. Step 1
  2. Step 2

Expected Result

Actual Result

Observations

[High level observations before doing any debugging]

Workaround

[If available]

Debugging

Hypothesis Prediction Experiment Results Conclusion
--- ----- ---- ---- ----
--- ----- ---- ---- ----

Root cause

[short desription or bullets to root cause]

Solution

[Short description about the right solution.] [Defer if right needs more brain storming and add description about any short term solution]

Next steps

[Action to be taken to environment, test strategy, feedback to user experience, feature design]

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment