timmc-edx

• Why did [mistaken action] seem like the correct action at the time?
• Why was the problem not detected automatically?
  • Why was the mistake caught late, not early?
• Why was the problem not fixed automatically?
  • Why did this require manual intervention?
  • Why did this require human detection?
• Were any of the contributing factors already known problems?
  • Why were they not addressed earlier?
  • Have we seen these in previous RCAs?

timmc-edx

Have the following been addressed in the branch, if appropriate?

• Tests (unit, API, integration)
• Docs (source comments, doc directory, elsewhere)
• Changelog
• Compatibility with previous versions (calls, shared files or DBs, data formats -- backward and forward compatibility)
• Rollback friendly?
• Feature switches?

edX-specific considerations:

timmc-edx

# python3 ./first.py

import second
import builtins

builtins.magic = "wow"

second.some_func()

timmc-edx

Where do the different docs live?

• "Developer Documentation"
  • https://edx.readthedocs.io/projects/edx-developer-docs
  • Repo: https://github.com/edx/edx-developer-docs
  • « This the landing page for documentation relevant to developers of the Open edX platform. »
  • Linked from https://docs.edx.org/ as "Developers"
  • Declares itself the new (vs. legacy) developer docs
• Links to https://edx.readthedocs.io/projects/edx-developer-guide