Skip to main content

YYYY-MM-DD: Short title

Date​

YYYY-MM-DD HH:mm Timezone

Summary​

Summary of the issue.

Authors​

The engineers involved in resolving the issue.

Impact​

The information about the impact of the issue including:

  • affected infrastructure elements
  • affected product features
  • affected users

Root Cause​

The description of the root cause of the issue.

Trigger​

What triggered the issue.

Detection​

Description on how the issue was detected.

Resolution​

Description on how the issue was resolved.

Timeline​

The timeline of the events related to the issue in form of the table:

TimeDescription
2022-07-28 19:00:01First item related to the issue
2022-07-28 19:10:02Second item related to the issue

Action Items (optional)​

The follow up items for the issue with GitHub issues linked.

Retrospective (optional)​

The section on the retrospective related to the issue.

Lessons Learned (optional)​

What we learned from resolving the issue.

What went well (optional)​

What went well when it comes to discovering and resolving the issue.

What went wrong (optional)​

What went wrong when it comes to discovering and resolving the issue.

Additional Information (optional)​

Any additional information related to the issue.